sc::ReplSC...bblockIter(3)

πŸ“¦
version 2.3.1 Β· 4 versions
, in fedora 43, ubuntu noble

🌸 NAME 🌸

sc::ReplSCMatrixListSubblockIter β€” that's the name, bestie, all of it, every letter. It's long, it's giving "my parents named me after the entire periodic table," and we're gonna respect it anyway πŸ’…


✨ SYNOPSIS ✨

Okay so the vibe: this class inherits sc::SCMatrixListSubblockIter. That's the whole family tree up front. Everything else below is either something it brings itself or something it got handed down πŸ’–

πŸŽ€ Public Member Functions

  • ReplSCMatrixListSubblockIter (Access, const Ref< SCMatrixBlockList > &list, const Ref< MessageGrp > &grp, double *data, int ndata) β€” the constructor, the origin story, the main character moment. It takes an Access, a reference to a SCMatrixBlockList called list, a reference to a MessageGrp called grp, a double * called data, and an int called ndata. Five things. Slay.

πŸ’« Public Member Functions inherited from sc::SCMatrixListSubblockIter

  • SCMatrixListSubblockIter (Access, const Ref< SCMatrixBlockList > &list) β€” the parent constructor, takes an Access and a list reference, that's it, no notes.
  • void begin () β€” start at the beginning. Ground zero. The origin point. Iconic behaviour tbh.
  • int ready () β€” returns nonzero if there is another block. So like, nonzero = "yes bestie there's more," zero = "we're done here πŸ₯²".
  • void next () β€” proceed to the next block. Keep it moving, no loitering.
  • SCMatrixBlock * block () β€” return the current block. Hand it over.

πŸ’« Public Member Functions inherited from sc::SCMatrixSubblockIter

  • SCMatrixSubblockIter (Access access) β€” and listen, the access variable should be one of Read, Write, Accum, and None, with the SCMatrixSubblockIter:: scope operator applied. Do not forget the scope operator, I'm begging 🫢
  • Access access () const β€” returns the type of Access allowed for these blocks.

πŸ’« Public Member Functions inherited from sc::RefCount

  • 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, this one shows up with no description. It's mysterious. It's a little enigmatic. Respect it anyway πŸ’œ
  • void unmanage () β€” turn off the reference counting mechanism for this object.
  • int managed () const β€” and here it is again, this time with lore: return 1 if the object is managed, otherwise return 0. Two separate entries, same signature. We do not merge them. We do not question them. They're both real πŸ’€

πŸ’« Public Member Functions inherited from sc::Identity

  • Identifier identifier () β€” return the Identifier for this argument.

🧚 Protected Attributes

  • Ref< MessageGrp > grp_ β€” protected, so hands off unless you're family.
  • double * data_
  • int ndata_

🧚 Protected Attributes inherited from sc::SCMatrixListSubblockIter

  • Ref< SCMatrixBlockList > list_
  • SCMatrixBlockListIter iter_

🧚 Protected Attributes inherited from sc::SCMatrixSubblockIter

  • Access access_

🌈 Additional Inherited Members

⭐ Public Types inherited from sc::SCMatrixSubblockIter

  • enum Access { Read, Write, Accum, None } β€” four options, that's the whole menu, choose wisely.

⭐ Protected Member Functions inherited from sc::RefCount

  • RefCount (const RefCount &) β€” the copy constructor, protected, so it's giving "invite only."
  • RefCount & operator= (const RefCount &) β€” the assignment operator, also protected, also invite only.

πŸ‘‘ Author

Generated automatically by Doxygen for MPQC from the source code. So like, no human wrote this, a robot did, and honestly? The robot ate. πŸ€–βœ¨


Fr fr, that's the whole page. Nothing skipped, nothing merged, every single inherited member accounted for. Periodt. πŸ’…

MPQC, Version 2.3.1 β€” mwah, love u, bye bestie πŸ«ΆπŸŽ€πŸ¦‹

πŸ“¦ where this page comes from