sc::SymmSCMatrix(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

💖 sc::SymmSCMatrix 💖

okay bestie, welcome to the MPQC manual page for sc::SymmSCMatrix(3) — the abstract base class for symmetric double valued matrices. She’s giving abstract-base-class royalty, and we’re obsessed. 👑✨

✨ NAME ✨

sc::SymmSCMatrix — the SymmSCMatrix class is the abstract base class for symmetric double valued matrices. periodt. 💅

🌸 SYNOPSIS 🌸

#include <abstract.h>
  • Inherits sc::DescribedClass.
  • Inherited by sc::BlockedSymmSCMatrix, sc::DistSymmSCMatrix, sc::LocalSymmSCMatrix, and sc::ReplSymmSCMatrix. the whole nepo-baby matrix family, honestly. 🫶

💖 Public Member Functions 💖

  • SymmSCMatrix (const RefSCDimension &, SCMatrixKit *) — constructor vibe: you bring a dimension ref and a matrix kit pointer, and the object gets made. ✨
  • Ref< SCMatrixKit > kit () const — Return the SCMatrixKit object that created this object. know your maker, bestie. 🎀
  • virtual void save (StateOut &) — Save and restore this in an implementation independent way. 💾
  • virtual void restore (StateIn &) — the restore half of the save/restore pair; the source description says save and restore this in an implementation independent way. reload that state, queen. 🌸
  • virtual double maxabs () const — Return the maximum absolute value element of this vector. yes, the original says vector — we’re keeping the wording, no editing the source’s moment. 💀
  • virtual void randomize () — Assign each element to a random number between -1 and 1. 🎲
  • void assign (double val) — Set all elements to val. one value to rule them all. ✨
  • void assign (const double *m) — Assign element i, j to m[i*(i+1)/2+j]. 🧮
  • void assign (const double **m) — Assign element i, j to m[i][j]. 🌸
  • void assign (SymmSCMatrix *m) — Make this have the same elements as m. 🫶
  • virtual void assign_val (double val) — Overridden to implement the assign functions. the assign machinery’s secret main character. 👑
  • virtual void assign_p (const double *m) — signature only in the source, bestie. 💅
  • virtual void assign_pp (const double **m) — signature only in the source. ✨
  • virtual void assign_s (SymmSCMatrix *m) — signature only in the source. 🎀
  • virtual void convert (double *) const — Like the assign members, but these write values to the arguments. assign’s flirty cousin. 💜
  • virtual void convert (double **) const — the double-pointer convert overload; source gives the shared convert blurb above. 🌈
  • virtual void convert (SymmSCMatrix *) — Convert an SCSymmSCMatrix of a different specialization to this specialization and possibly accumulate the data. specialization glow-up plus data accumulation, iykyk. ✨
  • virtual void convert_accumulate (SymmSCMatrix *) — signature only in the source. 💅
  • virtual void scale (double) — Multiply all elements by val. 🧚
  • virtual void scale_diagonal (double) — Scale the diagonal elements by val. 🌸
  • virtual void shift_diagonal (double) — Shift the diagonal elements by val. 🦋
  • virtual void unit () — Make this equal to the unit matrix. identity crisis? solved. 👑
  • int n () const — Return the dimension. 📏
  • virtual SymmSCMatrix * copy () — Return a matrix with the same dimension and same elements. 🫶
  • virtual SymmSCMatrix * clone () — Return a matrix with the same dimension but uninitialized memory. same shape, blank slate, very fresh-start energy. ✨
  • RefSCDimension dim () const — Return the dimension. 🎀
  • virtual double get_element (int, int) const =0 — Return or modify an element. 🧮
  • virtual void set_element (int, int, double)=0 — the modify side of the return-or-modify-an-element situation. 💅
  • virtual void accumulate_element (int, int, double)=0 — signature only in the source. 🌸
  • virtual SCMatrix * get_subblock (int br, int er, int bc, int ec)=0 — Return a subblock of this. 🧩
  • virtual SymmSCMatrix * get_subblock (int br, int er)=0 — the two-argument get_subblock overload; signature only in the source. 🫶
  • virtual void assign_subblock (SCMatrix *m, int, int, int, int)=0 — Assign m to a subblock of this. 🎀
  • virtual void assign_subblock (SymmSCMatrix *m, int, int)=0 — the symmetric-matrix assign_subblock overload. ✨
  • virtual void accumulate_subblock (SCMatrix *m, int, int, int, int)=0 — Sum m into a subblock of this. ➕
  • virtual void accumulate_subblock (SymmSCMatrix *m, int, int)=0 — the symmetric-matrix accumulate_subblock overload. 🌸
  • virtual SCVector * get_row (int i)=0 — Return a row of this. 🧵
  • virtual void assign_row (SCVector *v, int i)=0 — Assign v to a row of this. 🎀
  • virtual void accumulate_row (SCVector *v, int i)=0 — Sum v to a row of this. ➕
  • virtual void diagonalize (DiagSCMatrix *d, SCMatrix *m)=0 — Diagonalize this, placing the eigenvalues in d and the eigenvectors in m. the eigenvalues said “put me in d,” the eigenvectors said “put me in m,” and honestly? iconic. 👑
  • virtual void accumulate (const SymmSCMatrix *m)=0 — Sum m into this. ➕
  • virtual void accumulate_symmetric_sum (SCMatrix *)=0 — Sum into this the products of various vectors or matrices. 🧮
  • virtual void accumulate_symmetric_product (SCMatrix *) — signature only in the source. ✨
  • virtual void accumulate_transform (SCMatrix *, SymmSCMatrix *, SCMatrix::Transform=SCMatrix::NormalTransform) — transform-accumulate overload with the SCMatrix::NormalTransform default. 🌈
  • virtual void accumulate_transform (SCMatrix *, DiagSCMatrix *, SCMatrix::Transform=SCMatrix::NormalTransform) — transform-accumulate overload with DiagSCMatrix * and the same default. 💜
  • virtual void accumulate_transform (SymmSCMatrix *, SymmSCMatrix *) — the symmetric-matrix transform-accumulate overload. 🦋
  • virtual void accumulate_symmetric_outer_product (SCVector *) — signature only in the source. 🎀
  • virtual double scalar_product (SCVector *v) — Return the scalar obtained by multiplying this on the left and right by v. 🧮
  • virtual double trace ()=0 — Return the trace. the diagonal’s greatest hits. ✨
  • virtual double invert_this ()=0 — Invert this. 🔄
  • virtual double determ_this ()=0 — Return the determinant of this. this is overwritten. important caveat, bestie: this gets overwritten — do not miss that. 🚨
  • virtual double solve_this (SCVector *)=0 — signature only in the source. 💅
  • virtual void gen_invert_this ()=0 — signature only in the source. 🌸
  • virtual void element_op (const Ref< SCElementOp > &)=0 — Perform the element operation op on each element of this. 🧚
  • virtual void element_op (const Ref< SCElementOp2 > &, SymmSCMatrix *)=0 — the SCElementOp2 element-op overload. ✨
  • virtual void element_op (const Ref< SCElementOp3 > &, SymmSCMatrix *, SymmSCMatrix *)=0 — the SCElementOp3 element-op overload. 🌈
  • void print (std::ostream &o=ExEnv::out0()) const — Print out the matrix. 🖨️
  • void print (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const — print overload with title, out, and int=10. 🎀
  • virtual void vprint (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const — virtual print overload with the same title, out, and int=10 shape. ✨
  • Ref< MessageGrp > messagegrp () const — Returns the message group used by the matrix kit. 📬
  • virtual Ref< SCMatrixSubblockIter > local_blocks (SCMatrixSubblockIter::Access)=0 — Returns iterators for the local (rapidly accessible) blocks used in this matrix. ⚡
  • virtual Ref< SCMatrixSubblockIter > all_blocks (SCMatrixSubblockIter::Access)=0 — Returns iterators for the all blocks used in this matrix. 🌸

🎀 Protected Attributes 🎀

  • RefSCDimension d — protected dimension ref, just vibing in the protected section. 💜
  • Ref< SCMatrixKit > kit_ — protected matrix-kit ref, also just vibing. 🫶

🫶 ADDITIONAL INHERITED MEMBERS 🫶

The page includes this heading, but it doesn’t list any extra member details in this section. We’re not inventing any, bestie — no cap. 💅

🌈 DETAILED DESCRIPTION 🌈

The SymmSCMatrix class is the abstract base class for symmetric double valued matrices. same energy as NAME, but now with extra detailed-description lighting. ✨

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

💜 void sc::SymmSCMatrix::assign (SymmSCMatrix * m) [inline]

Make this have the same elements as m. The dimensions must match. matching dimensions or it’s not happening, bestie. 🫶

🧩 virtual SCMatrix* sc::SymmSCMatrix::get_subblock (int br, int er, int bc, int ec) [pure virtual]

Return a subblock of this. The subblock is defined as the rows starting at br and ending at er, and the columns beginning at bc and ending ec. rows first, then columns — keep the coordinates cute and correct. 🎀

Implemented in sc::BlockedSymmSCMatrix, sc::ReplSymmSCMatrix, sc::DistSymmSCMatrix, and sc::LocalSymmSCMatrix. the subblock implementation squad showed up. 👑

⭐ AUTHOR ⭐

Generated automatically by Doxygen for MPQC from the source code. thanks, Doxygen bestie. 🫶

okay that’s the whole page, bestie! 💖 This was Version 2.3.1 of the MPQC manual, dated Sun Oct 4 2020, on the sc::SymmSCMatrix(3) page. slay, stay abstract, stay symmetric. ✨👑

📦 where this page comes from