sc::BlockedSCElementOp(3)

💖 sc::BlockedSCElementOp 💖

okay bestie, welcome to sc::BlockedSCElementOp — this is the sc library, manual section 3 (library functions, the good stuff), and yes this page is lowkey just a class reference but we're gonna make it cute. 🦋

It inherits sc::SCElementOp. And plot twist: it's inherited by sc::LevelShift. So it's giving middle-of-the-family-tree energy. 🌈

---

✨ SYNOPSIS ✨

Inherits sc::SCElementOp.

Inherited by sc::LevelShift.

🌸 Public Member Functions 🌸

• void working_on (int)
• int current_block () const

💜 Public Member Functions inherited from sc::SCElementOp 💜

• SCElementOp (StateIn &s)
• virtual int has_collect () — okay so if duplicates of the SCElementOp exist (meaning there's more than one node, no biggie), then if has_collect returns nonzero, collect gets called with a MessageGrp reference after all the blocks have been processed. slay.
• virtual void defer_collect (int)
• virtual void collect (const Ref< MessageGrp > &)
• virtual void collect (const Ref< SCElementOp > &) — when you're using cloneable SCElementOp objects multithreaded, you gotta have the data from the cloned objects collected. it's giving housekeeping, it's giving necessary.
• virtual int has_side_effects () — by default this returns nonzero. periodt.
• 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. twin behavior, literally.
• virtual void process (SCMatrixBlockIter &)=0 — this is the fallback routine for processing blocks, and it gets called by the process_spec members that aren't overridden. the safety net bestie.
• void process_base (SCMatrixBlock *block) — lazy matrix implementors (affectionate) can call this member when the type of block specialization is unknown.
• virtual void process_spec_rect (SCMatrixRectBlock *)
• virtual void process_spec_ltri (SCMatrixLTriBlock *)
• virtual void process_spec_diag (SCMatrixDiagBlock *)
• virtual void process_spec_vsimp (SCVectorSimpleBlock *)
• virtual void process_spec_rectsub (SCMatrixRectSubBlock *)
• virtual void process_spec_ltrisub (SCMatrixLTriSubBlock *)
• virtual void process_spec_diagsub (SCMatrixDiagSubBlock *)
• virtual void process_spec_vsimpsub (SCVectorSimpleSubBlock *) — matrices should call these members when the type of block is known. iykyk. 💅

🎀 Public Member Functions inherited from sc::SavableState 🎀

• SavableState & operator= (const SavableState &)
• void save_state (StateOut &) — save the state of the object, exactly as specified by the StateOut object.
• void save_object_state (StateOut &) — use this for saving state when you know the exact type of the object for both the save and the restore. no guessing, we love that for us.
• virtual void save_vbase_state (StateOut &) — save the virtual bases for the object.
• virtual 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. order matters bestie, don't play. 😭

🌟 Public Member Functions inherited from sc::DescribedClass 🌟

• DescribedClass (const DescribedClass &)
• DescribedClass & operator= (const DescribedClass &)
• ClassDesc * class_desc () const throw () — returns the unique pointer to the ClassDesc corresponding to the given type_info object.
• const char * class_name () const — return the name of the object's exact type.
• int class_version () const — return the version of the class.
• virtual void print (std::ostream &=ExEnv::out0()) const — print the object.

💖 Public Member Functions inherited from sc::RefCount 💖

• int lock_ptr () const — lock this object.
• int unlock_ptr () const — unlock this object.
• void use_locks (bool inVal) — start and stop using locks on this object.
• refcount_t nreference () const — return the reference count.
• refcount_t reference () — increment the reference count and return the new count.
• refcount_t dereference () — decrement the reference count and return the new count.
• int managed () const
• void unmanage () — turn off the reference counting mechanism for this object.
• int managed () const — return 1 if the object is managed. otherwise return 0.

🦋 Public Member Functions inherited from sc::Identity 🦋

• Identifier identifier () — return the Identifier for this argument.

---

🌈 Additional Inherited Members 🌈

⭐ Static Public Member Functions inherited from sc::SavableState ⭐

• static void save_state (SavableState *s, StateOut &)
• static SavableState * restore_state (StateIn &si) — restores objects that were saved with save_state.
• static SavableState * key_restore_state (StateIn &si, const char *keyword) — like restore_state, but keyword is used to override values while restoring.
• static SavableState * dir_restore_state (StateIn &si, const char *objectname, const char *keyword=0)

🍓 Protected Member Functions inherited from sc::SavableState 🍓

• SavableState (const SavableState &)
• SavableState (StateIn &) — each derived class StateIn CTOR handles the restore corresponding to calling save_object_state, save_vbase_state, and save_data_state listed above.

💀 Protected Member Functions inherited from sc::RefCount 💀

• RefCount (const RefCount &)
• RefCount & operator= (const RefCount &)

---

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code. (not a human, just a lil robot doing its thing, and honestly? it ate. 🙈)

---

and that's the whole page bestie, no cap. go forth and block those SCElementOps. 💅✨

later, legend — this was MPQC, Version 2.3.1, manual page sc::BlockedSCElementOp(3). mwah 🫶🎀