sc::MsgMemoryGrp(3)

πŸ“¦
version 2.3.1 Β· 5 versions
, in ubuntu jammy

πŸ’– sc::MsgMemoryGrp(3) πŸ’–

okay bestie, welcome to the glow-up of the sc::MsgMemoryGrp(3) page from the MPQC manual ✨ this one's all about a MsgMemoryGrp that initializes its data using a messagegrp, and honestly? it's giving foundational. let's get into it 🫢


🌸 NAME 🌸

sc::MsgMemoryGrp β€” a MsgMemoryGrp that initializes its data using a messagegrp. that's literally the whole vibe, no cap πŸ’…


πŸŽ€ SYNOPSIS πŸŽ€

#include <memmsg.h>

so first things first: it Inherits sc::MemoryGrp. family tree moment πŸ‘‘

and it's Inherited by sc::ActiveMsgMemoryGrp, sc::RDMAMemoryGrp, and sc::ShmMemoryGrp β€” yes bestie, this one's the parent of three whole classes, main character energy fr fr 🌟

✨ Public Member Functions ✨

  • MsgMemoryGrp(const Ref<MessageGrp>& msg) β€” constructor #1, takes a Ref to a MessageGrp, iconic πŸ¦‹
  • MsgMemoryGrp(const Ref<KeyVal>& keyval) β€” constructor #2, this one's a Ref to a KeyVal, lowkey a different flavor πŸ’œ
  • void set_localsize(size_t localsize) β€” sets the size of locally held memory, periodt πŸ’…
  • void sync() β€” synchronizes all the nodes, we love a group effort 🌈

🌸 Protected Attributes 🌸

  • Ref<MessageGrp> msg_ β€” the MessageGrp ref chillin' in protected-attribute land πŸ™ˆ

🌟 Additional Inherited Members 🌟

there's more where that came from β€” this class also carries all the additional inherited members, iykyk (check the parent class docs for the full set) ✨


πŸ’– Detailed Description πŸ’–

A MsgMemoryGrp that initializes its data using a messagegrp. literally what it says on the tin, and we stan a class that knows exactly what it is πŸŽ€


πŸ¦‹ Member Function Documentation πŸ¦‹

🌸 void sc::MsgMemoryGrp::set_localsize(size_t) [virtual] 🌸

Set the size of locally held memory. and here's the detail that matters β€” when memory is accessed using a global offset, counting starts at node 0 and proceeds up to node n() - 1. write that down bestie, that's the whole map πŸ—ΊοΈβœ¨

Implements sc::MemoryGrp.

Reimplemented in sc::ShmMemoryGrp, and sc::RDMAMemoryGrp. look at the legacy, we love to see it πŸ‘‘

🌈 void sc::MsgMemoryGrp::sync() [virtual] 🌈

Synchronizes all the nodes. literally so useful β€” this one's your bestie after remote memory writes, when you need to be certain that all of the writes have completed and the data can be accessed locally, for example. trust the sync, fr fr 🫢

Implements sc::MemoryGrp.

Reimplemented in sc::MTMPIMemoryGrp.


πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code. so like... not written by a human hand, but we're serving it anyway πŸ’…βœ¨


πŸ’€ quick vibe check: this page is auto-generated from the source, so if something looks off, that's a source-code situation, not a typo situation, no cap.

and that's the whole page, bestie!! πŸ“ you ate. stay iconic, keep syncing your nodes, and remember:

Version 2.3.1 πŸŽ€ Sun Oct 4 2020 πŸŽ€ β€” that's the source, version and date from the footer, preserved with love πŸ«ΆπŸ’œ

bye bestie, go read some more manpages, mwah πŸ˜­πŸ’–

πŸ“¦ where this page comes from