sc::SCElementInvert(3)

🎀 sc::SCElementInvert(3) — MPQC manual page, bestie 🎀

okay so you opened the MPQC manual page for sc::SCElementInvert, and we're gonna make it make sense. no cap.

🌸 NAME 🌸

sc::SCElementInvert — that's the class this whole page is about, bestie. (MPQC is the manual name, folded in right here at the top so we don't have to copy the header line like a robot.)

✨ SYNOPSIS ✨

Inherits sc::SCElementOp.

💖 Public Member Functions 💖

• SCElementInvert (double threshold=0.0) — constructor that takes a double threshold, with default 0.0.
• SCElementInvert (StateIn &) — constructor that takes a StateIn &.
• int has_side_effects () — by default this returns nonzero.
• void save_data_state (StateOut &) — saves the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.
• void process (SCMatrixBlockIter &) — the fallback routine that processes blocks; it's called by process_spec members that are not overridden.
• int has_collect () — if duplicates of the SCElementOp exist (that is, there is more than one node), then if has_collect returns nonzero, collect is called with a MessageGrp reference after all the blocks have been processed.
• void defer_collect (int) — takes an int; this page doesn't give it a separate blurb.
• void collect (const Ref< MessageGrp > &) — takes a Ref< MessageGrp > &; this page doesn't give it a separate blurb.
• void collect (const Ref< SCElementOp > &) — multithreaded use of cloneable SCElementOp objects requires that data from cloned objects be collected.
• int result () — takes no args and returns an int; this page doesn't give it a separate blurb.

🦋 Additional Inherited Members 🦋

This section is here in the source page, but it doesn't list any extra inherited members underneath it. That's the whole tea.

📚 Member Function Documentation 📚

💅 void sc::SCElementInvert::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 from sc::SCElementOp.

💅 int sc::SCElementInvert::has_collect () [virtual]

If duplicates of the SCElementOp exist (that is, there is more than one node), then if has_collect returns nonzero, 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 the defer_collect member is called with nonzero, collect will do nothing (this is only used by the blocked matrices).

Reimplemented from sc::SCElementOp.

💅 int sc::SCElementInvert::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 from sc::SCElementOp.

💅 void sc::SCElementInvert::save_data_state (StateOut &) [virtual]

Save 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.

🫶 Author 🫶

Generated automatically by Doxygen for MPQC from the source code.

---

okay that's the whole page, bestie. it's from MPQC version 2.3.1, dated Sun Oct 4 2020, and the footer vibe is sc::SCElementInvert(3). byeee 💜