sc::DiagSCMatrix(3)

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

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

okay so welcome to the MPQC manual page for sc::DiagSCMatrix β€” it's giving abstract-base-class main character energy for diagonal double valued matrices. no cap, this page is a whole little vibe. ✨

πŸŽ€ NAME πŸŽ€

sc::DiagSCMatrix β€” The SymmSCMatrix class is the abstract base class for diagonal double valued matrices.

✨ SYNOPSIS ✨

#include <abstract.h>

Inherits sc::DescribedClass.

Inherited by sc::BlockedDiagSCMatrix, sc::DistDiagSCMatrix, sc::LocalDiagSCMatrix, and sc::ReplDiagSCMatrix.

🌸 Public Member Functions 🌸

  • DiagSCMatrix (const RefSCDimension &, SCMatrixKit *) β€” constructor lineup, exactly as written; the page gives no extra description here. 🫢
  • Ref< SCMatrixKit > kit () const β€” Return the SCMatrixKit used to create this object.
  • virtual void save (StateOut &) β€” Save and restore this in an implementation independent way.
  • virtual void restore (StateIn &) β€” no separate description on the page, bestie.
  • virtual double maxabs () const β€” Return the maximum absolute value element of this vector.
  • virtual void randomize () β€” Assign each element to a random number between -1 and 1.
  • void assign (double val) β€” Set all elements to val.
  • void assign (const double *p) β€” Assign element i, i to m[i].
  • void assign (DiagSCMatrix *d_a) β€” Make this have the same elements as m.
  • virtual void assign_val (double val) β€” Overridden to implement the assign members.
  • virtual void assign_p (const double *) β€” no extra note on the page.
  • virtual void assign_d (DiagSCMatrix *) β€” no extra note on the page.
  • virtual void convert (double *) const β€” Like the assign member, but this writes values to the argument.
  • virtual void convert (DiagSCMatrix *) β€” Convert an SCDiagSCMatrix of a different specialization to this specialization and possibly accumulate the data.
  • virtual void convert_accumulate (DiagSCMatrix *) β€” no extra note on the page.
  • virtual void scale (double) β€” Multiply all elements by val.
  • int n () const β€” Return the dimension.
  • virtual DiagSCMatrix * copy () β€” Return a matrix with the same dimension and same elements.
  • virtual DiagSCMatrix * clone () β€” Return a matrix with the same dimension but uninitialized memory.
  • RefSCDimension dim () const β€” Return the dimension.
  • virtual double get_element (int) const =0 β€” Return or modify an element.
  • virtual void set_element (int, double)=0 β€” no extra note on the page.
  • virtual void accumulate_element (int, double)=0 β€” no extra note on the page.
  • virtual void accumulate (const DiagSCMatrix *m)=0 β€” Sum m into this.
  • virtual double trace ()=0 β€” Return the trace.
  • virtual double determ_this ()=0 β€” Return the determinant of this. this is overwritten.
  • virtual double invert_this ()=0 β€” Invert this.
  • virtual void gen_invert_this ()=0 β€” Do a generalized inversion of this.
  • 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 > &, DiagSCMatrix *)=0 β€” no extra note on the page.
  • virtual void element_op (const Ref< SCElementOp3 > &, DiagSCMatrix *, DiagSCMatrix *)=0 β€” no extra note on the page.
  • 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 β€” no extra note on the page.
  • virtual void vprint (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const β€” no extra note on the page.
  • 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
  • Ref< SCMatrixKit > kit_

πŸ¦‹ Additional Inherited Members πŸ¦‹

the page literally just has this heading and then no extra member bullets under it β€” iconic minimalism, honestly. πŸ¦‹

🌈 Detailed Description 🌈

The SymmSCMatrix class is the abstract base class for diagonal double valued matrices.

yes bestie, it really says SymmSCMatrix there β€” not me fixing it, periodt. πŸ’…

🧚 Member Function Documentation 🧚

πŸ’œ void sc::DiagSCMatrix::assign (DiagSCMatrix * d_a) [inline] πŸ’œ

Make this have the same elements as m. The dimensions must match.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code.


πŸŽ€ that's the whole page, bestie. Version 2.3.1, dated Sun Oct 4 2020, from the MPQC manual for sc::DiagSCMatrix(3). slay and bye. πŸ’…βœ¨
πŸ“¦ where this page comes from