.TH "sc::BcastState" 3 "Sun Oct 4 2020" "Version 2.3.1" "MPQC" \" -*- nroff -*-
.ad l
.nh
.SH NAME
sc::BcastState \- This creates and forwards/retrieves data from either a \fBBcastStateRecv\fP or a \fBBcastStateSend\fP depending on the value of the argument to constructor\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <mstate\&.h>\fP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBBcastState\fP (const \fBRef\fP< \fBMessageGrp\fP > &, int source=0)"
.br
.RI "Create a \fBBcastState\fP object\&. The default source is node 0\&. "
.ti -1c
.RI "void \fBbcast\fP (int &)"
.br
.RI "Broadcast data to all nodes\&. "
.ti -1c
.RI "void \fBbcast\fP (double &)"
.br
.ti -1c
.RI "void \fBbcast\fP (int *&, int)"
.br
.ti -1c
.RI "void \fBbcast\fP (double *&, int)"
.br
.ti -1c
.RI "template<class T > void \fBbcast\fP (\fBRef\fP< T > &a)"
.br
.ti -1c
.RI "void \fBflush\fP ()"
.br
.RI "Force data to be written\&. "
.ti -1c
.RI "void \fBforget_references\fP ()"
.br
.RI "Call the \fBStateOut\fP or \fBStateIn\fP forget_references member\&. "
.ti -1c
.RI "void \fBset_buffer_size\fP (int)"
.br
.RI "Controls the amount of data that is buffered before it is sent\&. "
.in -1c
.SH "Detailed Description"
.PP 
This creates and forwards/retrieves data from either a \fBBcastStateRecv\fP or a \fBBcastStateSend\fP depending on the value of the argument to constructor\&. 
.SH "Member Function Documentation"
.PP 
.SS "void sc::BcastState::bcast (int &)"

.PP
Broadcast data to all nodes\&. After these are called for a group of data the flush member must be called to force the source node to actually write the data\&. 
.SS "void sc::BcastState::flush ()"

.PP
Force data to be written\&. Data is not otherwise written until the buffer is full\&. 

.SH "Author"
.PP 
Generated automatically by Doxygen for MPQC from the source code\&.