sc::SCMatrixKit(3)

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

NAME πŸŽ€

Welcome to the MPQC manual page for sc::SCMatrixKit(3), bestie! The NAME tea is: sc::SCMatrixKit β€” The SCMatrixKit abstract class acts as a factory for producing matrices. It's literally a factory for matrices, and the vibe is immaculate. ✨

SYNOPSIS 🌸

#include <abstract.h>

Inherits sc::DescribedClass.

Inherited by sc::BlockedSCMatrixKit, sc::DistSCMatrixKit, sc::LocalSCMatrixKit, and sc::ReplSCMatrixKit. The whole girl squad of matrix kits, no cap. πŸ’…

Public Member Functions 🫢

  • SCMatrixKit (const Ref< KeyVal > &) β€” the listed constructor-style signature, exactly as the page says. πŸŽ€
  • Ref< MessageGrp > messagegrp () const β€” the messagegrp signature, word for word.
  • virtual SCMatrix * matrix (const RefSCDimension &, const RefSCDimension &)=0 β€” Given the dimensions, create matrices or vectors. That's the main-character factory move. πŸ‘‘
  • virtual SymmSCMatrix * symmmatrix (const RefSCDimension &)=0 β€” listed exactly, with its =0 right there.
  • virtual DiagSCMatrix * diagmatrix (const RefSCDimension &)=0 β€” listed exactly, =0 included.
  • virtual SCVector * vector (const RefSCDimension &)=0 β€” listed exactly, =0 included.
  • SCMatrix * restore_matrix (StateIn &, const RefSCDimension &, const RefSCDimension &) β€” Given the dimensions and a StateIn object, restore matrices or vectors. Restore-era, fr fr.
  • SymmSCMatrix * restore_symmmatrix (StateIn &, const RefSCDimension &) β€” the listed restore signature, exactly.
  • DiagSCMatrix * restore_diagmatrix (StateIn &, const RefSCDimension &) β€” the listed restore signature, exactly.
  • SCVector * restore_vector (StateIn &, const RefSCDimension &) β€” the listed restore signature, exactly.

Static Public Member Functions πŸ’–

  • static SCMatrixKit * default_matrixkit () β€” This returns a LocalSCMatrixKit, unless the default has been changed with set_default_matrixkit. So that's the default-kit situation, periodt.
  • static void set_default_matrixkit (const Ref< SCMatrixKit > &) β€” the listed static signature, exactly. No extra description on the page.

Protected Attributes πŸ”’

  • Ref< MessageGrp > grp_ β€” the protected grp_ attribute, exactly as listed.

Additional Inherited Members 🌈

Yep, there are additional inherited members β€” the original page just names this section and keeps it moving. No list here, bestie.

Detailed Description πŸ¦‹

The SCMatrixKit abstract class acts as a factory for producing matrices.

By using one of these, the program makes sure that all of the matrices are consistent. Consistency is the whole point, and this is the vibe check that keeps all the matrices matching. 🌟

Author ✨

Generated automatically by Doxygen for MPQC from the source code. The robots really said "docs mode on" and honestly? They ate. πŸ’€


Okay bestie, that's the whole page! Cute sign-off tea: this is Version 2.3.1, dated Sun Oct 4 2020, for sc::SCMatrixKit(3) from the MPQC manual. Byeeee πŸ’…βœ¨πŸ«Ά

πŸ“¦ where this page comes from