sc::LocalSCMatrix(3)

💖 NAME 💖

sc::LocalSCMatrix — the local SCMatrix icon of the MPQC manual. Bestie, this is her page, and the way she’s giving local matrix main character energy is literally iconic. 💅✨

🌸 SYNOPSIS 🌸

Inherits sc::SCMatrix.

🫶 Public Member Functions 🫶

• LocalSCMatrix (const RefSCDimension &, const RefSCDimension &, LocalSCMatrixKit *) — the constructor, taking the two dimension refs and a LocalSCMatrixKit *.
• void assign_val (double) — overridden to implement assigning members. 💅
• double get_element (int, int) const — return or modify an element.
• void set_element (int, int, double) — also in the return-or-modify-an-element squad.
• void accumulate_element (int, int, double) — same element-modifying energy as above.
• SCMatrix * get_subblock (int, int, int, int) — return a subblock of this.
• void assign_subblock (SCMatrix *, int, int, int, int, int=0, int=0) — assign m to a subblock of this.
• void accumulate_subblock (SCMatrix *, int, int, int, int, int=0, int=0) — sum m into a subblock of this.
• SCVector * get_row (int i) — return a row or column of this.
• SCVector * get_column (int i) — the column version, same row-or-column energy.
• void assign_row (SCVector *v, int i) — assign v to a row or column of this.
• void assign_column (SCVector *v, int i) — the column version of that assign move.
• void accumulate_row (SCVector *v, int i) — sum v to a row or column of this.
• void accumulate_column (SCVector *v, int i) — the column version of that sum move.
• void accumulate_outer_product (SCVector *, SCVector *) — sum into this the products of various vectors or matrices.
• void accumulate_product_rr (SCMatrix *, SCMatrix *) — an accumulate-product move with two SCMatrix * besties.
• void accumulate_product_rs (SCMatrix *, SymmSCMatrix *) — same product-accumulate vibe, with an SCMatrix * and a SymmSCMatrix *.
• void accumulate_product_rd (SCMatrix *, DiagSCMatrix *) — product-accumulate with an SCMatrix * and a DiagSCMatrix *.
• void accumulate (const SCMatrix *) — sum m into this.
• void accumulate (const SymmSCMatrix *) — the SymmSCMatrix overload.
• void accumulate (const DiagSCMatrix *) — the DiagSCMatrix overload.
• void accumulate (const SCVector *) — the SCVector overload.
• void transpose_this () — transpose this.
• double invert_this () — invert this.
• void svd_this (SCMatrix *U, DiagSCMatrix *sigma, SCMatrix *V) — compute the singular value decomposition for this, possibly destroying this. ⚠️
• double solve_this (SCVector *) — solve-this, exactly with that SCVector *.
• double determ_this () — return the determinant of this; this is overwritten.
• double trace () — return the trace.
• void schmidt_orthog (SymmSCMatrix *, int) — Schmidt orthogonalize this.
• int schmidt_orthog_tol (SymmSCMatrix *, double tol, double *res=0) — Schmidt orthogonalize this.
• void element_op (const Ref< SCElementOp > &) — perform the element operation op on each element of this.
• void element_op (const Ref< SCElementOp2 > &, SCMatrix *) — element-op overload with an SCMatrix *.
• void element_op (const Ref< SCElementOp3 > &, SCMatrix *, SCMatrix *) — element-op overload with two SCMatrix *.
• void vprint (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const — the vprint signature, exactly as written.
• double * get_data () — get the data pointer.
• double ** get_rows () — get the rows pointer.
• 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.

💜 Friends 💜

• class LocalSymmSCMatrix
• class LocalDiagSCMatrix
• class LocalSCVector

🦋 Additional Inherited Members 🦋

Okay bestie, the page also has an Additional Inherited Members section. It doesn’t spill extra deets here — it’s just chillin’ as a heading. 🫶

🔥 Member Function Documentation 🔥

SCMatrix* sc::LocalSCMatrix::get_subblock (int br, int er, int bc, int ec) [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 at ec.

Implements sc::SCMatrix. 💅

void sc::LocalSCMatrix::schmidt_orthog (SymmSCMatrix *, int n) [virtual]

Schmidt orthogonalize this. S is the overlap matrix. n is the number of columns to orthogonalize.

Implements sc::SCMatrix.

int sc::LocalSCMatrix::schmidt_orthog_tol (SymmSCMatrix *, double tol, double * res = 0) [virtual]

Schmidt orthogonalize this. S is the overlap matrix. tol is the tolerance. The number of linearly independent vectors is returned.

Implements sc::SCMatrix.

🎀 Author 🎀

Generated automatically by Doxygen for MPQC from the source code. 🤖✨

---

MPQC version 2.3.1, dated Sun Oct 4 2020 — mwah, bestie, you made it to the end! 💖👑