sc::SCElementMaxAbs(3)

🎀 NAME

sc::SCElementMaxAbs — that’s the class name, bestie, and this whole page is the MPQC manual lowdown on it. ✨

🌸 SYNOPSIS

Okay so, synopsis vibe check: it inherits from sc::SCElementOp.

💅 Public Member Functions

• SCElementMaxAbs (StateIn &) — constructor that takes a StateIn &.
• void save_data_state (StateOut &) — save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.
• void process (SCMatrixBlockIter &) — this is the fallback routine to process blocks, and 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 of the blocks have been processed.
• void defer_collect (int) — takes an int; the original page doesn’t add extra notes here. 🙈
• void collect (const Ref< MessageGrp > &) — takes const Ref< MessageGrp > &; no extra description on the original page.
• void collect (const Ref< SCElementOp > &) — multithreaded use of cloneable SCElementOp objects requires that data from cloned objects be collected.
• double result () — returns a double.

🫶 Additional Inherited Members

Yep, there are additional inherited members — the original page puts this heading here but doesn’t list extra ones.

💜 Member Function Documentation

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

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

int sc::SCElementMaxAbs::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 — and this is only used by the blocked matrices. Reimplemented from sc::SCElementOp.

void sc::SCElementMaxAbs::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.

---

MPQC version 2.3.1, dated Sun Oct 4 2020 — that’s the source/version and date sign-off for sc::SCElementMaxAbs(3), and that’s the whole page, bestie. 💖✨🦋