sc::SCElementMinAbs(3)

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

πŸ’… NAME πŸ’…

Okay bestie, you're in the MPQC manual, section 3, and the star of this page is sc::SCElementMinAbs πŸ’– β€” yes, that's the whole name, and yes, it ate.


✨ SYNOPSIS ✨

sc::SCElementMinAbs inherits from sc::SCElementOp. No cap, that's the parent class situation.

🫢 Public Member Functions 🫢

  • SCElementMinAbs (double rinit) β€” constructor that takes a double rinit.
  • SCElementMinAbs (StateIn &) β€” constructor that takes a StateIn &.
  • 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 &) β€” this is the fallback routine to process blocks, and it's called by process_spec members that are not overridden.
  • int has_collect () β€” related to duplicate SCElementOp objects, collection behavior, and the defer_collect situation. Full tea below πŸ‘‡
  • void defer_collect (int) β€” takes an int; no extra description on this page.
  • void collect (const Ref< MessageGrp > &) β€” takes a const Ref< MessageGrp > &; no extra description on this 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; no extra description on this page.

πŸ¦‹ Additional Inherited Members πŸ¦‹

This heading is present, but the page doesn't list any extra inherited members underneath it. It's giving "section exists, details not listed" energy 🫢.


🌸 Member Function Documentation 🌸

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

Bestie, 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::SCElementMinAbs::has_collect () [virtual]

Okay so: 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 the defer_collect member is called with nonzero, collect will do nothing β€” and this is only used by the blocked matrices. Periodt.

Reimplemented from sc::SCElementOp.

🧚 void sc::SCElementMinAbs::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. Iconic serialization behavior, honestly ✨.

Reimplemented from sc::SavableState.


🌈 Author 🌈

Generated automatically by Doxygen for MPQC from the source code. Not a human author moment β€” the robots did this one πŸ€–πŸ’–.


xoxo, your Unix bestie πŸ’… β€” this page is Version 2.3.1, dated Sun Oct 4 2020 πŸŽ€

πŸ“¦ where this page comes from