sc::GlobalMsgIter(3)

💖 sc::GlobalMsgIter 💖

okay bestie, pull up a chair 🪑 because we're talking about sc::GlobalMsgIter — that's the sc:: one, from the Library Functions Manual, section 3 if you're keeping score. It's the little iterator that handles your global message passing vibes and honestly? she's serving.

---

✨ NAME ✨

sc::GlobalMsgIter — yes that's her whole name, she's mysterious like that 💅

---

🦋 SYNOPSIS 🦋

She inherits from sc::DescribedClass.

And get this — she's inherited by sc::HypercubeGMI. so she's got a legacy, a whole bloodline, main character energy fr fr 👑

🌸 Public Member Functions 🌸

okay so here's her own repertoire, no nepo baby behaviour, all her own work:

• GlobalMsgIter(int nproc, int me, int root=0) — the constructor, she's born. root defaults to 0 because of course it does.
• void backwards() — go backwards, queen.
• void forwards() — and now go forwards. versatility ✨
• void next() — next one, please, we're moving.
• int done() — are we done here or what
• int n() — the n
• int sendto() — who are we sending to
• int send() — send it
• int recvfrom() — who sent this to us
• int recv() — receive it

💜 Public Member Functions inherited from sc::DescribedClass 💜

the family traits, passed down:

• DescribedClass(const DescribedClass &) — copy constructor, she's a copycat (affectionate)
• DescribedClass & operator=(const DescribedClass &) — assignment operator, giving main character the same energy
• ClassDesc * class_desc() const throw() — This returns the unique pointer to the ClassDesc corresponding to the given type_info object.
• const char * class_name() const — Return the name of the object's exact type. (yes, exact type, she doesn't do approximations)
• int class_version() const — Return the version of the class.
• virtual void print(std::ostream &=ExEnv::out0()) const — Print the object. that's it, that's the job 🎀

🌈 Public Member Functions inherited from sc::RefCount 🌈

the reference-counting side of the family, obsessed with her tbh:

• int lock_ptr() const — Lock this object.
• int unlock_ptr() const — Unlock this object.
• void use_locks(bool inVal) — start and stop using locks on this object
• refcount_t nreference() const — Return the reference count.
• refcount_t reference() — Increment the reference count and return the new count.
• refcount_t dereference() — Decrement the reference count and return the new count.
• int managed() const — (yes she's listed twice in the original, we don't question the icon's choices)
• void unmanage() — Turn off the reference counting mechanism for this object.
• int managed() const — Return 1 if the object is managed. Otherwise return 0.

🫶 Public Member Functions inherited from sc::Identity 🫶

• Identifier identifier() — Return the Identifier for this argument.

🧚 Protected Member Functions 🧚

these are the private-ish ones, for the inner circle only:

• virtual int fwdsendto()=0 — pure virtual, meaning you gotta implement this yourself, no skipping 😤
• virtual int fwdsend()=0 — also pure virtual, also on you
• virtual int fwdrecvfrom()=0 — pure virtual, still on you bestie
• virtual int fwdrecv()=0 — pure virtual, last one, you got this

💀 Protected Member Functions inherited from sc::RefCount 💀

• RefCount(const RefCount &) — the copy constructor
• RefCount & operator=(const RefCount &) — and the assignment operator

🍓 Protected Attributes 🍓

the lil data members tucked away:

• int me_
• int nproc_
• int root_
• int i_
• int n_
• int fwd_

---

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code. yeah, a robot wrote her bio, she's still iconic 💅✨

---

and that's the whole page, bestie 🫶 this was MPQC Version 2.3.1, filed under sc::GlobalMsgIter(3). go forth and iterate, globally 🌍💖