sc::SCMatrixSubblockIter(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

💖 NAME 💖

okay so bestie, this is sc::SCMatrixSubblockIter(3) from the MPQC manual, and it’s literally the guide to the iterator objects that go block by block. Objects of class SCMatrixSubblockIter are used to iterate through the blocks of a matrix. That’s the whole name vibe. 💅

🦋 SYNOPSIS 🦋

#include <block.h>
  • Inherits sc::RefCount.
  • Inherited by sc::SCMatrixCompositeSubblockIter, sc::SCMatrixJointSubblockIter, sc::SCMatrixListSubblockIter, sc::SCMatrixNullSubblockIter, and sc::SCMatrixSimpleSubblockIter.

🌸 Public Types 🌸

  • enum Access { Read, Write, Accum, None } — the access enum, serving all four options exactly like that. 🫶

🎀 Public Member Functions 🎀

  • SCMatrixSubblockIter (Access access) — constructor time! The access variable should be one of Read, Write, Accum, and None, with the SCMatrixSubblockIter:: scope operator applied. 👑
  • virtual void begin ()=0 — start at the beginning.
  • virtual int ready ()=0 — returns nonzero if there is another block.
  • virtual void next ()=0 — proceed to the next block.
  • virtual SCMatrixBlock * block ()=0 — return the current block.
  • Access access () const — return the type of Access allowed for these blocks.

🔒 Protected Attributes 🔒

  • Access access_ — the protected attribute listed on the page. Keep it protected, keep it cute. 🔐

🧚 Additional Inherited Members 🧚

This section exists on the page, but it doesn’t spell out any additional inherited members under it. That’s the tea. 🍵

💅 Detailed Description 💅

Objects of class SCMatrixSubblockIter are used to iterate through the blocks of a matrix.

⚠️ real talk: the object must be deleted before using the matrix that owns the blocks that SCMatrixSubblockIter is iterating through. Do not skip this step, bestie — this is the kind of thing that will absolutely ruin your whole day. 😭

✨ Author ✨

Generated automatically by Doxygen for MPQC from the source code. Yes, Doxygen did the typing, we’re just adding the sparkle. ✨

And that’s the page, signing off from the MPQC source with version 2.3.1, dated Sun Oct 4 2020. Mwah 💋🎀

📦 where this page comes from