sc::SCMatrixBlockIter(3)

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

πŸ’… sc::SCMatrixBlockIter β€” the manual, bestie edition πŸ’…

Okay so real talk, this is the sc::SCMatrixBlockIter manpage from the MPQC manual, and honestly? It's giving "let me introduce you to my little iterator friend." No cap, it's actually so useful. Let's get into it. 🫢


✨ NAME ✨

sc::SCMatrixBlockIter β€” the vibes are: this class is used to describe iterators that loop through the elements in a block. Periodt. That's literally its whole personality. πŸ’–


🌸 SYNOPSIS 🌸

Like, first things first, you gotta pull it in:

#include <blkiter.h>

And listen β€” it's inherited by a whole squad of subclasses. Not me listing them all but here we go:

  • sc::SCMatrixDiagBlockIter
  • sc::SCMatrixDiagSubBlockIter
  • sc::SCMatrixLTriBlockIter
  • sc::SCMatrixLTriSubBlockIter
  • sc::SCMatrixRectBlockIter
  • sc::SCMatrixRectSubBlockIter
  • sc::SCVectorSimpleBlockIter
  • sc::SCVectorSimpleSubBlockIter

It's giving main character energy with that many spin-offs, honestly. πŸ‘‘


πŸŽ€ Public Member Functions πŸŽ€

These are the moves, bestie. Every single one, no skips:

  • virtual int i () = 0 β€” returns the row index. Slay. That's your row, bestie. πŸ“
  • virtual int j () = 0 β€” returns the column index. Yes, column. We love a coordinate moment. πŸ“
  • virtual void set (double val) = 0 β€” sets the current element to val. Iconic behaviour, honestly. ✨
  • virtual void accum (double val) β€” adds val to the current element. It's not a set, it's an accum. Respect the distinction. πŸ’…
  • virtual double get () = 0 β€” returns the value of the current element. Obsessed. πŸ“
  • virtual operator int () = 0 β€” returns nonzero if there are more elements. Like, a vibe check: are we still iterating or are we done? iykyk. ⭐
  • virtual void operator++ () = 0 β€” moves to the next element. Om nom nom, next please. πŸ¦‹
  • void operator++ (int) β€” the postfix version. Hey, don't sleep on it just because it's not pure virtual. 🌈
  • virtual void reset () = 0 β€” starts the iteration over. It's giving second chances, and honestly? We love a reset era. πŸ’œ

πŸ¦‹ Detailed Description πŸ¦‹

So the SCMatrixBlockIter class is used to describe iterators that loop through the elements in a block. That's it. That's the whole thing. Genuinely iconic in its simplicity. πŸ’€


🧚 Author 🧚

Generated automatically by Doxygen for MPQC from the source code. Not a human, just a robot being helpful. Not me being jealous of a documentation generator. 😭


⭐ Version ⭐

Version 2.3.1 β€” dated Sun Oct 4 2020. A vintage. A classic. A moment in time. 🌸


And that's the whole spread, bestie. Go forth and iterate responsibly. Remember: i() and j() for coordinates, get() to peek, set() to assign, accum() to add, and operator int() to know when to stop. The loop is the journey, fr fr. πŸ’–βœ¨

β€” signed, your Unix-obsessed bestie, here for you always 🫢

πŸ“¦ where this page comes from