sc::SCElementKNorm(3)

💖 sc::SCElementKNorm 💖

okay bestie, welcome to the MPQC manual — you're on the page for sc::SCElementKNorm(3), and it is literally about the computed k-norm of a matrix. no cap. ✨

---

🌸 NAME 🌸

sc::SCElementKNorm — Computed k-norm of matrix. that's the whole name section and it ate. 💅

✨ SYNOPSIS ✨

#include <elemop.h>

Inherits sc::SCElementOp. 🫶

🎀 Public Member Functions 🎀

• SCElementKNorm (double k=2.0) — constructor moment ⭐ by default compute 2-norm.
• SCElementKNorm (StateIn &) — the constructor that takes a StateIn &; no extra deets here in the original.
• 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 is 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 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). 😭
• void defer_collect (int) — takes an int; the original doesn't give extra description here.
• void collect (const Ref< MessageGrp > &) — takes a const Ref< MessageGrp > &; no extra description here.
• 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 here.
• void init () — no extra description here.

🫶 Additional Inherited Members 🫶

The original page has this heading but doesn't list any extra members under it. that's the whole vibe. 🦋

💅 Detailed Description 💅

Computed k-norm of matrix. periodt. 👑

🧚 Member Function Documentation 🧚

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

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

---

This absolute icon of a page is from the MPQC docs, version 2.3.1, dated Sun Oct 4 2020. byeee, go compute that k-norm bestie 🎀💜