sc::SCElementOp(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

🌸 sc::SCElementOp(3) — the MPQC manual, bestie edition 🌸

okay so this is the sc::SCElementOp(3) page from the MPQC manual, and it's all about SCElementOp objects — the little icons that perform operations on the elements of matrices. Let's get into it. 💅

🌸 NAME 🌸

sc::SCElementOp — objects of class SCElementOp are used to perform operations on the elements of matrices. 💖

✨ SYNOPSIS ✨

#include <elemop.h>

Inherits sc::SavableState.

Inherited by:

  • sc::BlockedSCElementOp
  • sc::OneBodyIntOp
  • sc::SCElementAccumulateDiagSCMatrix
  • sc::SCElementAccumulateSCMatrix
  • sc::SCElementAccumulateSCVector
  • sc::SCElementAccumulateSymmSCMatrix
  • sc::SCElementAssign
  • sc::SCElementDot
  • sc::SCElementInvert
  • sc::SCElementKNorm
  • sc::SCElementMaxAbs
  • sc::SCElementMinAbs
  • sc::SCElementRandomize
  • sc::SCElementScale
  • sc::SCElementScaleDiagonal
  • sc::SCElementShiftDiagonal
  • sc::SCElementSquareRoot
  • sc::SCElementSumAbs

💅 Public Member Functions 💅

  • SCElementOp (StateIn &s) — the constructor, taking a StateIn &s. No extra blurb in the public list.
  • virtual int has_collect () — if duplicates of the SCElementOp exist (that is, there is more than one node), then if has_collect returns nonzero then collect is called with a MessageGrp reference after all of the blocks have been processed. Full tea is below. 🫖
  • virtual void defer_collect (int) — listed here; no extra blurb in the public list.
  • virtual void collect (const Ref< MessageGrp > &) — listed here; no extra blurb in the public list.
  • virtual void collect (const Ref< SCElementOp > &) — multithreaded use of cloneable SCElementOp objects requires that data from cloned objects be collected.
  • virtual int has_side_effects () — by default this returns nonzero.
  • virtual bool threadsafe () — returns true if this SCElementOp is threadsafe.
  • virtual bool cloneable () — returns true if this SCElementOp supports the cloneable member.
  • virtual Ref< SCElementOp > clone () — returns a clone of this object.
  • virtual void process (SCMatrixBlockIter &)=0 — this is the fallback routine to process blocks and is called by process_spec members that are not overridden.
  • void process_base (SCMatrixBlock *block) — lazy matrix implementors can call this member when the type of block specialization is unknown.
  • virtual void process_spec_rect (SCMatrixRectBlock *) — matrices should call these members when the type of block is known.
  • virtual void process_spec_ltri (SCMatrixLTriBlock *) — listed here; no extra blurb.
  • virtual void process_spec_diag (SCMatrixDiagBlock *) — listed here; no extra blurb.
  • virtual void process_spec_vsimp (SCVectorSimpleBlock *) — listed here; no extra blurb.
  • virtual void process_spec_rectsub (SCMatrixRectSubBlock *) — listed here; no extra blurb.
  • virtual void process_spec_ltrisub (SCMatrixLTriSubBlock *) — listed here; no extra blurb.
  • virtual void process_spec_diagsub (SCMatrixDiagSubBlock *) — listed here; no extra blurb.
  • virtual void process_spec_vsimpsub (SCVectorSimpleSubBlock *) — listed here; no extra blurb.

🎀 Additional Inherited Members 🎀

The original page has this marker, and no extra bullet details are listed under it. That's it, that's the section. 💀

💜 Detailed Description 💜

Objects of class SCElementOp are used to perform operations on the elements of matrices.

When the SCElementOp object is given to the element_op member of a matrix, each block the matrix is passed to one of the process, process_base, or process_base members. (Yes, the original really says process_base twice — I'm keeping the facts exactly as they are, no cap. 💅)

🦋 Member Function Documentation 🦋

💫 clone 💫

virtual Ref<SCElementOp> sc::SCElementOp::clone () [virtual]

Returns a clone of this object. This is needed for multithreaded use of SCElementOp objects that are not thread safe. The default implementation throws an exception.

Reimplemented in sc::OneBodyIntOp.

💫 cloneable 💫

virtual bool sc::SCElementOp::cloneable () [virtual]

Returns true if this SCElementOp supports the cloneable member. The default implementation returns false.

Reimplemented in sc::OneBodyIntOp.

💫 collect (const Ref< SCElementOp > &) 💫

virtual void sc::SCElementOp::collect (const Ref< SCElementOp > &) [virtual]

Multithreaded use of cloneable SCElementOp objects requires that data from cloned objects be collected. The default implementation will throw an exception.

Reimplemented in sc::SCElementKNorm, sc::SCElementSumAbs, sc::SCElementMinAbs, sc::SCElementMaxAbs, and sc::SCElementInvert.

💫 has_collect 💫

virtual int sc::SCElementOp::has_collect () [virtual]

If duplicates of the SCElementOp exist (that is, there is more than one node), then if has_collect returns nonzero then collect is called with a MessageGrp reference after all of the blocks have been processed. The default return value of has_collect is 0 and collect's default action is do nothing. If defer_collect member is called with nonzero, collect will do nothing (this is only used by the blocked matrices).

Reimplemented in sc::SCElementKNorm, sc::SCElementSumAbs, sc::SCElementMinAbs, sc::SCElementMaxAbs, and sc::SCElementInvert.

💫 has_side_effects 💫

virtual int sc::SCElementOp::has_side_effects () [virtual]

By default this returns nonzero. If the ElementOp specialization will change any elements of the matrix, then this must be overridden to return nonzero.

Reimplemented in sc::SCElementAccumulateSCVector, sc::SCElementAccumulateDiagSCMatrix, sc::SCElementAccumulateSymmSCMatrix, sc::SCElementAccumulateSCMatrix, sc::SCElementDot, sc::OneBodyIntOp, sc::SCElementShiftDiagonal, sc::SCElementScaleDiagonal, sc::SCElementInvert, sc::SCElementSquareRoot, sc::SCElementAssign, sc::SCElementRandomize, sc::SCElementScale, and sc::LevelShift.

💫 process_base 💫

void sc::SCElementOp::process_base (SCMatrixBlock * block)

Lazy matrix implementors can call this member when the type of block specialization is unknown. However, this will attempt to dynamic_cast block to a block specialization and will thus be less efficient.

💫 process_spec_rect 💫

virtual void sc::SCElementOp::process_spec_rect (SCMatrixRectBlock *) [virtual]

Matrices should call these members when the type of block is known. ElementOp specializations should override these when efficiency is important, since these give the most efficient access to the elements of the block.

Reimplemented in sc::OneBodyIntOp.

💫 threadsafe 💫

virtual bool sc::SCElementOp::threadsafe () [virtual]

Returns true if this SCElementOp is threadsafe. The default implementation returns false.

🌈 Author 🌈

Generated automatically by Doxygen for MPQC from the source code.

okay bestie, that's the whole sc::SCElementOp(3) page. It's from MPQC — version 2.3.1, dated Sun Oct 4 2020. Go slay those matrix elements. 💖✨💅

📦 where this page comes from