sc::SCMatrixBlock(3)

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

πŸ’– NAME πŸ’–

okay bestie, welcome to the sc::SCMatrixBlock(3) page from the MPQC manual. The main character is SCMatrixBlock: the base clase for all types of blocks that comprise matrices and vectors. Yes, β€œclase” is literally in the source, and we respect the icon’s spelling πŸ’….

✨ SYNOPSIS ✨

#include <block.h>

Inherits sc::SavableState.

Inherited by:

  • sc::SCMatrixDiagBlock
  • sc::SCMatrixDiagSubBlock
  • sc::SCMatrixLTriBlock
  • sc::SCMatrixLTriSubBlock
  • sc::SCMatrixRectBlock
  • sc::SCMatrixRectSubBlock
  • sc::SCVectorSimpleBlock
  • sc::SCVectorSimpleSubBlock

πŸ› οΈ Public Member Functions πŸ› οΈ

  • SCMatrixBlock (StateIn &s) β€” constructor that takes a StateIn &s; the source page gives it no extra one-liner.
  • void save_data_state (StateOut &s) β€” saves the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.
  • virtual SCMatrixBlock * deepcopy () const β€” returns a copy of this.
  • virtual double * dat () β€” returns a pointer to the block’s data and the number of elements in the block.
  • virtual int ndat () const β€” returns an int and is const; the source page gives no extra description here.
  • virtual void process (SCElementOp *)=0 β€” pure virtual hook; the =0 is right there in the signature, and the source page adds no separate note.
  • virtual void process (SCElementOp2 *, SCMatrixBlock *)=0 β€” pure virtual hook; no extra description on the source page.
  • virtual void process (SCElementOp3 *, SCMatrixBlock *, SCMatrixBlock *)=0 β€” pure virtual hook; no extra description on the source page.

🧸 Public Attributes 🧸

  • int blocki β€” public attribute; the source page gives no extra description.
  • int blockj β€” public attribute; the source page gives no extra description.

🫧 Additional Inherited Members 🫧

The source page lists this heading but gives no extra member details underneath it on this page. That’s the whole section, bestie 🫢.

🌸 Detailed Description 🌸

SCMatrixBlock is the base clase for all types of blocks that comprise matrices and vectors. Again, β€œclase” is canon πŸ’€.

πŸ’… Member Function Documentation πŸ’…

πŸ¦‹ virtual double* sc::SCMatrixBlock::dat () [virtual]

Returns a pointer to the block’s data and the number of elements in the block. Some blocks cannot provide this information, and a runtime error will be generated if these members are called. These routines are only used internally in the matrix library.

Reimplemented in sc::SCMatrixDiagBlock, sc::SCMatrixLTriBlock, sc::SCMatrixRectBlock, and sc::SCVectorSimpleBlock.

πŸ¦‹ virtual SCMatrixBlock* sc::SCMatrixBlock::deepcopy () const [virtual]

Returns a copy of this. A runtime error will be generated for blocks that cannot do a deepcopy. These routines are only used internally in the matrix library.

Reimplemented in sc::SCMatrixDiagBlock, sc::SCMatrixLTriBlock, sc::SCMatrixRectBlock, and sc::SCVectorSimpleBlock.

πŸ¦‹ void sc::SCMatrixBlock::save_data_state (StateOut &) [virtual]

Saves the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. This must be implemented by the derived class if the class has data.

Reimplemented from sc::SavableState.

Reimplemented in sc::SCMatrixDiagSubBlock, sc::SCMatrixDiagBlock, sc::SCMatrixLTriSubBlock, sc::SCMatrixLTriBlock, sc::SCMatrixRectSubBlock, sc::SCMatrixRectBlock, sc::SCVectorSimpleSubBlock, and sc::SCVectorSimpleBlock.

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code.


Sign-off time, bestie: Version 2.3.1, Sun Oct 4 2020 β€” that’s the manual footer energy. Bye and slay πŸ’–βœ¨

πŸ“¦ where this page comes from