sc::SCMatrixListSubblockIter(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

💅 sc::SCMatrixListSubblockIter

okay bestie, so this is a whole manual page for sc::SCMatrixListSubblockIter from MPQC (that's the manual section 3 situation, iykyk) ✨ and it's literally the iterator that walks over subblocks in an SCMatrixBlockList. Sit with me, we're gonna get through it together 🫶

✨ SYNOPSIS ✨

So first thing, the family tree, because this class is very much giving nepo baby but make it C++:

  • Inherits sc::SCMatrixSubblockIter 👑 (that's the parent, respect it)
  • Inherited by sc::DistSCMatrixListSubblockIter, and sc::ReplSCMatrixListSubblockIter 🌈 (yes both of them, the whole little dynasty)

🌸 Public Member Functions

  • SCMatrixListSubblockIter (Access, const Ref< SCMatrixBlockList > &list) — the constructor, she takes an Access and a const Ref< SCMatrixBlockList > &list and that's it, that's the whole vibe.
  • void begin () — Start at the beginning. 💖 Like resetting your For You page, except it's blocks.
  • int ready () — Returns nonzero if there is another block. so like... truthy means "yeah there's more", zero means "we're done here bestie" 🎀
  • void next () — Proceed to the next block. obvious? yes. necessary? absolutely, no skipping 😤
  • SCMatrixBlock * block () — Return the current block. the main character of the moment, fr fr 🔥

🎀 Protected Attributes

these are the internals, protected, so like... don't touch unless you're built for it:

  • Ref< SCMatrixBlockList > list_ — the list ref, with the trailing underscore, that's the whole name, do not @ me
  • SCMatrixBlockListIter iter_ — the iterator, also with the underscore 💅

🦋 Additional Inherited Members

yeah there's more stuff inherited, it's just not listed here — the page keeps it mysterious 😭 (said so itself, "Additional Inherited Members" and then nothing, iconic honestly)

🌸 Author

Generated automatically by Doxygen for MPQC from the source code. literally a robot wrote this, no human to thank, not me being ungrateful it's just the facts 🙈

okay that's the whole page bestie, you ate that reading it 💜 nothing skipped, nothing made up, every flag-free detail present and accounted for ✨

— cute little sign-off: this was Version 2.3.1, dated Sun Oct 4 2020, brought to you by the fine people (well, Doxygen) of MPQC 🎀🫶 see you in the next man page, mwah 💋

📦 where this page comes from