sc::BcastState(3)

💖 sc::BcastState(3) 💖

🌸 NAME 🌸

Okay bestie, this is the MPQC manual page for sc::BcastState. It creates and forwards/retrieves data from either a BcastStateRecv or a BcastStateSend depending on the value of the argument to constructor. That's the whole assignment. 💅

✨ SYNOPSIS ✨

#include <mstate.h>

🎀 Public Member Functions 🎀

• BcastState (const Ref< MessageGrp > &, int source=0) — Create a BcastState object. The default source is node 0. 🫶
• void bcast (int &) — Broadcast data to all nodes.
• void bcast (double &) — another bcast overload; the manpage gives no separate description here.
• void bcast (int *&, int) — another bcast overload; no separate description here.
• void bcast (double *&, int) — another bcast overload; no separate description here.
• template<class T > void bcast (Ref< T > &a) — the template bcast overload; no separate description here.
• void flush () — Force data to be written.
• void forget_references () — Call the StateOut or StateIn forget_references member.
• void set_buffer_size (int) — Controls the amount of data that is buffered before it is sent.

🌈 Detailed Description 🌈

This creates and forwards/retrieves data from either a BcastStateRecv or a BcastStateSend depending on the value of the argument to constructor. Literally that's the entire detailed description, and we respect it. ✨

🔥 Member Function Documentation 🔥

💜 void sc::BcastState::bcast (int &) 💜

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. Periodt. 💅

🦋 void sc::BcastState::flush () 🦋

Force data to be written. Data is not otherwise written until the buffer is full. No cap. 💖

🌟 Author 🌟

Generated automatically by Doxygen for MPQC from the source code.

---

Source/version: MPQC 2.3.1 · date: Sun Oct 4 2020. Bye bestie, go slay those broadcasts! 💅✨