sc::RefDiagSCMatrix(3)

💖 sc::RefDiagSCMatrix 💖

okay bestie, this is the MPQC manual page for sc::RefDiagSCMatrix, and it is literally a smart pointer to an DiagSCMatrix specialization. stay with me, it's giving matrix-girlie energy 💅

---

✨ NAME ✨

sc::RefDiagSCMatrix — The RefDiagSCMatrix class is a smart pointer to an DiagSCMatrix specialization.

---

🦋 SYNOPSIS 🦋

#include <matrix.h>

Inherits sc::Ref< DiagSCMatrix >.

🌸 Public Member Functions 🌸

• RefDiagSCMatrix () — initializes the matrix pointer to 0, fr fr.
• RefDiagSCMatrix (const RefDiagSCMatrix &m) — makes this and m refer to the same SCMatrix.
• RefDiagSCMatrix (DiagSCMatrix *m) — makes this refer to m.
• RefDiagSCMatrix & operator= (DiagSCMatrix *m) — makes this refer to m.
• RefDiagSCMatrix & operator= (const RefDiagSCMatrix &m) — makes this and m refer to the same matrix.
• RefDiagSCMatrix (const RefSCDimension &, const Ref< SCMatrixKit > &) — creates a diagonal matrix with dimension d by d. 💫
• RefSCMatrix operator* (const RefSCMatrix &) const — multiplies this by a matrix and returns a matrix.
• RefDiagSCMatrix operator* (double) const — the double multiply, exactly as written.
• RefDiagSCMatrix operator+ (const RefDiagSCMatrix &) const — matrix addition and subtraction, the classic duo.
• RefDiagSCMatrix operator- (const RefDiagSCMatrix &) const — matrix addition and subtraction, same duo, different sign.
• RefDiagSCMatrix i () const — returns the inverse of this.
• RefDiagSCMatrix gi () const — returns the generalized inverse of this.
• RefDiagSCMatrix clone () const — these call the SCMatrix members of the same name after checking for references to 0.
• RefDiagSCMatrix copy () const — also calls the SCMatrix member of the same name after checking for references to 0.
• void set_element (int, double) const — sets an element, no extra lore in the source.
• void accumulate_element (int, double) const — accumulates an element.
• double get_element (int) const — gets an element.
• void randomize () const — randomizes it.
• void assign (const RefDiagSCMatrix &) const — assigns from another RefDiagSCMatrix.
• void scale (double) const — scales it by a double.
• void assign (double) const — assigns a double.
• void assign (const double *) const — assigns from a const double *.
• void convert (double *) const — converts into a double *.
• void accumulate (const RefDiagSCMatrix &) const — accumulates from another RefDiagSCMatrix.
• void element_op (const Ref< SCElementOp > &) const — element op with one SCElementOp.
• void element_op (const Ref< SCElementOp2 > &, const RefDiagSCMatrix &) const — element op with SCElementOp2 and a RefDiagSCMatrix.
• void element_op (const Ref< SCElementOp3 > &, const RefDiagSCMatrix &, const RefDiagSCMatrix &) const — element op with SCElementOp3 and two RefDiagSCMatrix besties.
• int n () const — returns n.
• RefSCDimension dim () const — returns the dimension.
• Ref< SCMatrixKit > kit () const — returns the kit.
• double trace () const — returns the trace.
• void print (std::ostream &) const — prints to an std::ostream.
• void print (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const — prints with a title, output stream, and that int=10 default, exactly as written.
• void save (StateOut &) — saves to StateOut.
• void restore (StateIn &) — restores the matrix from StateIn object. The matrix must have been initialized already. ⚠️
• double determ () const — returns the determinant of the referenced matrix.
• DiagSCMatrixdouble operator() (int i) const — assign and examine matrix elements. yes, that signature is exactly what the page says, no cap.
• int nblock () const — if this matrix is blocked return the number of blocks.
• RefDiagSCMatrix block (int i) const — if this matrix is blocked return block i.

🎀 Additional Inherited Members 🎀

There are additional inherited members too, because inheriting sc::Ref< DiagSCMatrix > is a whole thing. 💅

---

🌟 Detailed Description 🌟

The RefDiagSCMatrix class is a smart pointer to an DiagSCMatrix specialization. that's the whole vibe, bestie. 🫶

---

🎀 Constructor & Destructor Documentation 🎀

sc::RefDiagSCMatrix::RefDiagSCMatrix ()

Initializes the matrix pointer to 0. The reference must be initialized before it is used. periodt.

sc::RefDiagSCMatrix::RefDiagSCMatrix (const RefSCDimension &, const Ref< SCMatrixKit > &)

Create a diagonal matrix with dimension d by d. The data values are undefined. so like, don't expect cute little numbers in there automatically, okay? 😭

---

👑 Member Function Documentation 👑

RefDiagSCMatrix sc::RefDiagSCMatrix::block (int i) const

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

int sc::RefDiagSCMatrix::nblock () const

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

---

🌈 Author 🌈

Generated automatically by Doxygen for MPQC from the source code. not me, bestie, that's literally what it says. 💀

---

mwah 💋 this was Version 2.3.1, dated Sun Oct 4 2020, and the page is sc::RefDiagSCMatrix(3) — that's the whole manual page, and yes, it ate. 🎀✨