sc::SCElementShiftDiagonal(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

🦋 sc::SCElementShiftDiagonal — NAME 🦋

sc::SCElementShiftDiagonal — bestie, this is an element op from MPQC (the manual page lives in section 3, iykyk) and it's literally the "shift the diagonal" girlie 💅

✨ SYNOPSIS ✨

Inherits sc::SCElementOp 🫶 — so all that parent-class energy comes for free.

💖 Public Member Functions 💖

  • SCElementShiftDiagonal (double a) — constructor number one, takes a double a and gets to work 🌸
  • SCElementShiftDiagonal (StateIn &) — constructor number two, the restore-from-a-StateIn one 🎀
  • int has_side_effects () — by default this returns nonzero. (More deets down in the docs section 👇)
  • void save_data_state (StateOut &) — save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them ⭐
  • void process (SCMatrixBlockIter &) — the fallback routine that processes blocks; it gets called by process_spec members that aren't overridden 🔥

🌈 Additional Inherited Members 🌈

Yep — there's more stuff inherited from the base class, and it's chillin' in the "Additional Inherited Members" section. Free real estate, no cap 👑

📖 Member Function Documentation 📖

💜 int sc::SCElementShiftDiagonal::has_side_effects () [virtual]

By default this returns nonzero. And here's the important part, bestie: if the ElementOp specialization is gonna change any elements of the matrix, then this must be overridden to return nonzero. Like, no exceptions — the matrix is changing, so say so 🫡

Reimplemented from sc::SCElementOp.

🧚 void sc::SCElementShiftDiagonal::save_data_state (StateOut &) [virtual]

Save the base classes (call save_data_state on 'em) and the members in the exact same order that the StateIn CTOR initializes them — order matters, fr fr, don't freestyle it 🙈

This must be implemented by the derived class if the class has data. No data? Then you're off the hook.

Reimplemented from sc::SavableState.

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code. (So if the prose is a little stiff, blame the robot, not me 😭)

🎀 Sign-off 🎀

That's the whole vibe check, bestie — this page is Version 2.3.1, dated Sun Oct 4 2020, and she ate. Go shift some diagonals, slay, periodt 💅✨🍓

📦 where this page comes from