sc::ReplDiagSCMatrix(3)

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

πŸ’… sc::ReplDiagSCMatrix(3) β€” MPQC manual page, bestie edition πŸ’…

okay so this is the MPQC manual page for sc::ReplDiagSCMatrix, and we are gonna get through every single detail together. no cap. 🫢


🌸 NAME 🌸

sc::ReplDiagSCMatrix β€” the class this whole page is about, fr fr. πŸ’–

✨ SYNOPSIS ✨

the inheritance vibe check:

Inherits sc::DiagSCMatrix.

πŸ’– Public Member Functions πŸ’–

  • ReplDiagSCMatrix (const RefSCDimension &, ReplSCMatrixKit *) β€” the constructor signature, exactly as listed. πŸŽ€
  • void assign_val (double) β€” overridden to implement the assign members. slay. ✨
  • double get_element (int) const β€” the page says β€œReturn or modify an element.”
  • void set_element (int, double) β€” just the signature on this one, no extra note in the original. πŸ’…
  • void accumulate_element (int, double) β€” same deal: signature only. 🌸
  • void accumulate (const DiagSCMatrix *) β€” β€œSum m into this.”
  • double invert_this () β€” β€œInvert this.”
  • double determ_this () β€” β€œReturn the determinant of this. this is overwritten.” so yes, this gets overwritten, bestie, noted. 😭
  • double trace () β€” β€œReturn the trace.”
  • void gen_invert_this () β€” β€œDo a generalized inversion of this.”
  • void element_op (const Ref< SCElementOp > &) β€” β€œPerform the element operation op on each element of this.”
  • void element_op (const Ref< SCElementOp2 > &, DiagSCMatrix *) β€” another element_op overload, signature exact, no separate description in the original. πŸ¦‹
  • void element_op (const Ref< SCElementOp3 > &, DiagSCMatrix *, DiagSCMatrix *) β€” the third element_op overload, also signature-exact with no extra note. 🧚
  • void vprint (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const β€” no extra description in the original, just this exact signature. πŸ‘‘
  • double * get_data () β€” signature only, no extra note. ⭐
  • 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 the all blocks used in this matrix.”
  • Ref< ReplSCMatrixKit > skit () β€” signature only, no extra note. πŸ’œ

πŸŽ€ Protected Member Functions πŸŽ€

  • void init_blocklist () β€” protected member function, signature only. 🌈
  • void before_elemop () β€” protected member function, signature only. 🌸
  • void after_elemop () β€” protected member function, signature only. πŸ¦‹

🌟 Protected Attributes 🌟

  • Ref< SCMatrixBlockList > blocklist β€” protected attribute, listed exactly like this. πŸ’–
  • double * matrix β€” protected attribute, also exactly as listed. ✨

🫢 Friends 🫢

  • class ReplSCMatrix β€” friend class, bestie.
  • class ReplSymmSCMatrix β€” friend class, bestie.
  • class ReplSCVector β€” friend class, bestie. πŸ’…

πŸŽ€ Author πŸŽ€

the author line is literally: β€œGenerated automatically by Doxygen for MPQC from the source code.” πŸ’»βœ¨


okay bye bestie πŸ’– the footer energy is Version 2.3.1, dated Sun Oct 4 2020, and this whole cute little manual page comes from the MPQC source/version info. periodt. πŸ‘‘πŸŒΈ

πŸ“¦ where this page comes from