sc::RefSymmSCMatrix(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

🦋 sc::RefSymmSCMatrix(3) — the MPQC manual, bestie 🦋

okay so this is the sc::RefSymmSCMatrix(3) page from the MPQC manual, and we're gonna get through it together. no cap, every deet stays. 💅

💖 NAME 💖

sc::RefSymmSCMatrix — the RefSymmSCMatrix class is a smart pointer to an SCSymmSCMatrix specialization. periodt. ✨

✨ SYNOPSIS ✨

#include <matrix.h>

She inherits sc::Ref< SymmSCMatrix >. 🫶

🌟 Public Member Functions 🌟

Okay bestie, here's the whole roster — every signature exactly as the original serves it. If the original didn't give a one-liner, I'm not making one up; I'm just holding the line 💅.

  • RefSymmSCMatrix () — Initializes the matrix pointer to 0.
  • RefSymmSCMatrix (const RefSymmSCMatrix &m) — Make this and m refer to the same SCMatrix.
  • RefSymmSCMatrix (SymmSCMatrix *m) — Make this refer to m.
  • RefSymmSCMatrix & operator= (SymmSCMatrix *m) — Make this refer to m.
  • RefSymmSCMatrix & operator= (const RefSymmSCMatrix &m) — Make this and m refer to the same matrix.
  • RefSymmSCMatrix (const RefSCDimension &d, const Ref< SCMatrixKit > &) — Create a vector with dimension d by d.
  • RefSCMatrix operator* (const RefSCMatrix &) const — Multiply this by a matrix and return a matrix.
  • RefSCMatrix operator* (const RefSymmSCMatrix &) const — listed in the original, no extra note.
  • RefSCVector operator* (const RefSCVector &a) const — Multiply this by a vector and return a vector.
  • RefSymmSCMatrix operator* (double) const — listed in the original, no extra note.
  • RefSymmSCMatrix operator+ (const RefSymmSCMatrix &) const — Matrix addition and subtraction.
  • RefSymmSCMatrix operator- (const RefSymmSCMatrix &) const — the subtraction half of the same “Matrix addition and subtraction” note.
  • RefSymmSCMatrix i () const — Return the inverse of this.
  • RefSymmSCMatrix gi () const — Return the generalized inverse of this.
  • RefSymmSCMatrix clone () const — These call the SCMatrix members of the same name after checking for references to 0.
  • RefSymmSCMatrix copy () const — same “these call the SCMatrix members…” note.
  • void set_element (int, int, double) const — listed in the original, no extra note.
  • void accumulate_element (int, int, double) const — listed in the original, no extra note.
  • double get_element (int, int) const — listed in the original, no extra note.
  • RefSCMatrix get_subblock (int br, int er, int bc, int ec) — listed in the original, no extra note.
  • RefSymmSCMatrix get_subblock (int br, int er) — listed in the original, no extra note.
  • void assign_subblock (const RefSCMatrix &, int br, int er, int bc, int ec) — listed in the original, no extra note.
  • void assign_subblock (const RefSymmSCMatrix &, int br, int er) — listed in the original, no extra note.
  • void accumulate_subblock (const RefSCMatrix &, int, int, int, int) — listed in the original, no extra note.
  • void accumulate_subblock (const RefSymmSCMatrix &, int, int) — listed in the original, no extra note.
  • RefSCVector get_row (int) — listed in the original, no extra note.
  • void assign_row (const RefSCVector &, int) — listed in the original, no extra note.
  • void accumulate_row (const RefSCVector &, int) — listed in the original, no extra note.
  • void accumulate_symmetric_outer_product (const RefSCVector &) const — listed in the original, no extra note.
  • double scalar_product (const RefSCVector &) const — listed in the original, no extra note.
  • void accumulate_symmetric_product (const RefSCMatrix &) const — listed in the original, no extra note.
  • void accumulate_symmetric_sum (const RefSCMatrix &) const — listed in the original, no extra note.
  • void accumulate_transform (const RefSCMatrix &a, const RefSymmSCMatrix &b, SCMatrix::Transform=SCMatrix::NormalTransform) const — Add a * b * a.t() to this.
  • void accumulate_transform (const RefSCMatrix &a, const RefDiagSCMatrix &b, SCMatrix::Transform=SCMatrix::NormalTransform) const — listed in the original, no extra note.
  • void accumulate_transform (const RefSymmSCMatrix &a, const RefSymmSCMatrix &b) const — listed in the original, no extra note.
  • void randomize () const — listed in the original, no extra note.
  • void assign (const RefSymmSCMatrix &) const — listed in the original, no extra note.
  • void scale (double) const — listed in the original, no extra note.
  • void assign (double) const — listed in the original, no extra note.
  • void assign (const double *) const — listed in the original, no extra note.
  • void assign (const double **) const — listed in the original, no extra note.
  • void convert (double *) const — listed in the original, no extra note.
  • void convert (double **) const — listed in the original, no extra note.
  • void accumulate (const RefSymmSCMatrix &) const — listed in the original, no extra note.
  • void element_op (const Ref< SCElementOp > &) const — listed in the original, no extra note.
  • void element_op (const Ref< SCElementOp2 > &, const RefSymmSCMatrix &) const — listed in the original, no extra note.
  • void element_op (const Ref< SCElementOp3 > &, const RefSymmSCMatrix &, const RefSymmSCMatrix &) const — listed in the original, no extra note.
  • double trace () const — listed in the original, no extra note.
  • int n () const — listed in the original, no extra note.
  • RefSCDimension dim () const — listed in the original, no extra note.
  • Ref< SCMatrixKit > kit () const — listed in the original, no extra note.
  • void print (std::ostream &) const — listed in the original, no extra note.
  • void print (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const — listed in the original, no extra note.
  • void save (StateOut &) — listed in the original, no extra note.
  • void restore (StateIn &) — Restores the matrix from StateIn object. The matrix must have been initialized already.
  • double solve_lin (const RefSCVector &) const — Solves this x = v.
  • double determ () const — Returns the determinant of the referenced matrix.
  • RefDiagSCMatrix eigvals () const — Returns the eigenvalues of the reference matrix.
  • RefSCMatrix eigvecs () const — Returns the eigenvectors of the reference matrix.
  • void diagonalize (const RefDiagSCMatrix &eigvals, const RefSCMatrix &eigvecs) const — Sets eigvals to the eigenvalues and eigvecs to the eigenvalues and eigenvectors of the referenced matrix.
  • SymmSCMatrixdouble operator() (int i, int j) const — Assign and examine matrix elements. (yes, that spacing is exactly what the original says 💀)
  • int nblock () const — If this matrix is blocked return the number of blocks.
  • RefSymmSCMatrix block (int i) const — If this matrix is blocked return block i.

🫶 Additional Inherited Members 🫶

Nothing extra is listed under this heading in the original — it's just the heading, bestie. 💅

📖 Detailed Description 📖

The RefSymmSCMatrix class is a smart pointer to an SCSymmSCMatrix specialization. That's the whole vibe: smart pointer, scoped to that specialization. ✨

🛠️ Constructor & Destructor Documentation 🛠️

🎀 sc::RefSymmSCMatrix::RefSymmSCMatrix () 🎀

Initializes the matrix pointer to 0.

⚠️ The reference must be initialized before it is used.

🎀 sc::RefSymmSCMatrix::RefSymmSCMatrix (const RefSCDimension & d, const Ref< SCMatrixKit > &) 🎀

Create a vector with dimension d by d.

⚠️ The data values are undefined.

🔍 Member Function Documentation 🔍

🧚 RefSymmSCMatrix sc::RefSymmSCMatrix::block (int i) const 🧚

If this matrix is blocked return block i. Otherwise return this as block 0.

🧚 void sc::RefSymmSCMatrix::diagonalize (const RefDiagSCMatrix & eigvals, const RefSCMatrix & eigvecs) const 🧚

Sets eigvals to the eigenvalues and eigvecs to the eigenvalues and eigenvectors of the referenced matrix. The result satisfies eigvecs * eigvals * eigvecs.t() = (*this).

🧚 int sc::RefSymmSCMatrix::nblock () const 🧚

If this matrix is blocked return the number of blocks. Otherwise return 1.

🧚 double sc::RefSymmSCMatrix::solve_lin (const RefSCVector &) const 🧚

Solves this x = v. Overwrites v with x.

✍️ Author ✍️

Generated automatically by Doxygen for MPQC from the source code. So yeah, Doxygen cooked this one. 💅

💖 Version 2.3.1 · Sun Oct 4 2020 · sc::RefSymmSCMatrix(3) — bye bestie, go slay those matrices! 💖

📦 where this page comes from