sc::BlockedDiagSCMatrix(3)

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

πŸŽ€ sc::BlockedDiagSCMatrix(3) πŸŽ€

okay so bestie, this is the MPQC manual page for sc::BlockedDiagSCMatrix β€” yes, the name is a whole mouthful, but we move. πŸ’…


πŸ’– NAME πŸ’–

sc::BlockedDiagSCMatrix β€” that's the class, periodt.

✨ SYNOPSIS ✨

Inherits sc::DiagSCMatrix.

🌸 Public Member Functions 🌸

  • BlockedDiagSCMatrix (const RefSCDimension &, BlockedSCMatrixKit *) β€” the constructor; it takes a const RefSCDimension & and a BlockedSCMatrixKit *. no cap, that's the whole signature.
  • void save (StateOut &) β€” the save half of the β€œsave and restore this in an implementation independent way” note. cute.
  • void restore (StateIn &) β€” the restore half of that same note; signature only otherwise.
  • double get_element (int) const β€” the note here is literally β€œReturn or modify an element.” so that's the element-returning/modifying vibe.
  • void set_element (int, double) β€” setter energy; signature only, no extra note in the source.
  • void accumulate_element (int, double) β€” signature only; no extra blurb in the original.
  • void accumulate (const DiagSCMatrix *) β€” sums m into this. that's the whole note.
  • double invert_this () β€” inverts this.
  • double determ_this () β€” returns the determinant of this; heads up, this is overwritten. 😭
  • double trace () β€” returns the trace.
  • void gen_invert_this () β€” does a generalized inversion of this.
  • void element_op (const Ref< SCElementOp > &) β€” performs the element operation op on each element of this.
  • void element_op (const Ref< SCElementOp2 > &, DiagSCMatrix *) β€” takes a Ref< SCElementOp2 > and a DiagSCMatrix *; signature only, no extra note.
  • void element_op (const Ref< SCElementOp3 > &, DiagSCMatrix *, DiagSCMatrix *) β€” same vibe but with a Ref< SCElementOp3 > and two DiagSCMatrix *s; no extra note in the source.
  • void vprint (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const β€” the print function; no extra description, just those defaults: title=0, out=ExEnv::out0(), and int=10. default-argument icon behavior.
  • RefSCDimension dim () const β€” dimension getter; signature only.
  • RefSCDimension dim (int) const β€” dimension getter with an int; also signature only.
  • int nblocks () const β€” block count getter; signature only.
  • RefDiagSCMatrix block (int) β€” block getter; signature only.
  • Ref< SCMatrixSubblockIter > local_blocks (SCMatrixSubblockIter::Access) β€” returns iterators for the local (rapidly accessible) blocks used in this matrix.
  • Ref< SCMatrixSubblockIter > all_blocks (SCMatrixSubblockIter::Access) β€” returns iterators for all the blocks used in this matrix.

🫢 Friends 🫢

  • class BlockedSCMatrix
  • class BlockedSymmSCMatrix
  • class BlockedSCVector

these three are the friends list, no blurbs, just names. iconic.

🌈 Additional Inherited Members 🌈

the heading is here, but there are no extra listed members under it in the source β€” minimal, clean, done.

πŸ¦‹ Author πŸ¦‹

Generated automatically by Doxygen for MPQC from the source code. so not a human author, bestie β€” it's the robot.


Version 2.3.1 Β· Sun Oct 4 2020 Β· MPQC β€” that's the source/version and date tea, and we're out. πŸ’–βœ¨

πŸ“¦ where this page comes from