sc::SCVector(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

🌸 sc::SCVector(3) — MPQC 🌸

okay so bestie, you're looking at the manual page for sc::SCVector from MPQC, and it's literally the blueprint for double valued vectors. think of it as the main character energy that all the other vector classes inherit from. no cap, this is important stuff 💅✨

✨ NAME ✨

sc::SCVector — the abstract base class for double valued vectors. yeah, it's abstract, so you can't just instantiate it directly, but it's the blueprint that makes everything else work. it's giving foundation, it's giving template, it's giving "i'm the parent and you will respect me" 👑

🦋 SYNOPSIS 🦋

so first, you gotta include the header, like:

#include <abstract.h>

and it inherits from sc::DescribedClass, which is cute. and it's inherited by sc::BlockedSCVector, sc::DistSCVector, sc::LocalSCVector, and sc::ReplSCVector — so those are the actual implementations you'd use. the abstract one is just the vibe check 💫

🌈 Public Member Functions 🌈

here's the whole group chat of member functions, bestie. every single one, no skips:

  • SCVector (const RefSCDimension &, SCMatrixKit *) — the constructor, duh. takes a RefSCDimension and an SCMatrixKit* and sets up your vector.
  • virtual void save (StateOut &) — save this in an implementation independent way. it's giving "i need to remember myself" 💾
  • virtual void restore (StateIn &) — and this one brings it back. the yin to save's yang.
  • Ref< SCMatrixKit > kit () const — returns the SCMatrixKit that was used to create this object. like, where did you come from, king?
  • virtual SCVector * copy () — returns a vector with the same dimension and same elements. a literal clone, but make it fashion 💖
  • virtual SCVector * clone () — returns a vector with the same dimension but uninitialized memory. so it's shaped the same but empty inside, like my brain before coffee 😭
  • int n () const — returns the length of the vector. the number of elements, the count, the tea ☕
  • virtual double maxabs () const — returns the maximum absolute value element. the biggest vibe in the vector.
  • virtual void normalize () — normalizes this vector. makes it all neat and tidy, slay ✨
  • virtual void randomize () — assigns each element to a random number between -1 and 1. chaos mode activated 🔥
  • void assign (double val) — assigns all elements of this to val. every single one gets the same value.
  • void assign (const double *v) — assigns element i to v[i] for all i. copy-paste from an array, basically.
  • void assign (SCVector *v) — makes this have the same elements as v. and bestie, the dimensions must match, okay? no funny business 🚫
  • virtual void assign_val (double val) — this is overridden to implement the assign functions. so it's the behind-the-scenes queen.
  • virtual void assign_p (const double *v) — like assign but with a pointer. same energy.
  • virtual void assign_v (SCVector *v) — assign from another vector. the classic.
  • virtual void convert (double *v) const — assigns v[i] to element i for all i. the reverse of assign, kind of.
  • virtual void convert (SCVector *) — converts an SCVector of a different specialization to this specialization and possibly accumulates the data. it's giving "blend in with the crowd" 🫶
  • virtual void convert_accumulate (SCVector *) — same but with accumulation. add it up, bestie.
  • virtual void scale (double val) — multiplies each element by val. glow up for numbers 💅
  • RefSCDimension dim () const — returns the RefSCDimension corresponding to this vector. the shape, the size, the dimension honey.
  • virtual void set_element (int i, double val)=0 — set element i to val. pure virtual, so you HAVE to implement it in your subclass. no skipping 💀
  • virtual void accumulate_element (int, double)=0 — add val to element i. also pure virtual. also mandatory.
  • virtual double get_element (int i) const =0 — return the value of element i. you guessed it, pure virtual.
  • void accumulate_product (SymmSCMatrix *m, SCVector *v) — sum the result of m times v into this. math but make it cute 🧮
  • void accumulate_product (SCMatrix *m, SCVector *v) — same thing but with a regular SCMatrix. got options.
  • virtual void accumulate_product_sv (SymmSCMatrix *m, SCVector *v) — the symm version. sv stands for symm-vector, iykyk.
  • virtual void accumulate_product_rv (SCMatrix *m, SCVector *v)=0 — the regular matrix version, pure virtual. implement it or perish.
  • virtual void accumulate (const SCVector *v)=0 — sum v into this. pure virtual, bestie.
  • virtual void accumulate (const SCMatrix *m)=0 — sum m into this. one of m's dimensions must be 1. important detail! don't forget.
  • virtual double scalar_product (SCVector *)=0 — return the dot product. the classic vector move.
  • virtual void element_op (const Ref< SCElementOp > &)=0 — perform the element operation op on each element of this. element-wise, periodt.
  • virtual void element_op (const Ref< SCElementOp2 > &, SCVector *)=0 — binary element op. two vectors enter, one leaves.
  • virtual void element_op (const Ref< SCElementOp3 > &, SCVector *, SCVector *)=0 — ternary element op. it's a whole party.
  • void print (std::ostream &o=ExEnv::out0()) const — print out the vector. show it off to the world 🖨️
  • void print (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const — print with a title and output stream and an int (probably precision). the deluxe version.
  • virtual void vprint (const char *title=0, std::ostream &out=ExEnv::out0(), int=10) const =0 — the virtual print. pure virtual so subclasses can do their own thing.
  • Ref< MessageGrp > messagegrp () const — returns the message group used by the matrix kit. for all your parallel communication needs 📡
  • virtual Ref< SCMatrixSubblockIter > local_blocks (SCMatrixSubblockIter::Access)=0 — returns iterators for the local (rapidly accessible) blocks used in this vector. only one iterator is allowed if it has Accum or Write access. multiple Read iterators are permitted. read the fine print, bestie 📖
  • virtual Ref< SCMatrixSubblockIter > all_blocks (SCMatrixSubblockIter::Access)=0 — returns iterators for all the blocks used in this vector. the whole collection.

💜 Protected Attributes 💜

  • RefSCDimension d — the dimension, protected. it's lowkey but important.
  • Ref< SCMatrixKit > kit_ — the matrix kit, protected. the behind-the-scenes enabler.

🌟 Additional Inherited Members 🌟

there are additional inherited members from sc::DescribedClass, but they're not listed here. just know they exist and they're part of the family.

🎀 Detailed Description 🎀

okay so the SCVector class is the abstract base class for double valued vectors. periodt. that's the whole description. it's the foundation, the blueprint, the mother of all double vectors in MPQC. if you want a vector of doubles that does math and stuff, this is where it all begins 💖

🔥 Member Function Documentation 🔥

void sc::SCVector::assign (SCVector * v) [inline]

so this inline function makes this have the same elements as v. but bestie, the dimensions must match. if they don't, it's a no-go. no cap, check your dims before you assign 🚨

virtual Ref<SCMatrixSubblockIter> sc::SCVector::local_blocks (SCMatrixSubblockIter::Access) [pure virtual]

returns iterators for the local (rapidly accessible) blocks used in this vector. and here's the tea: only one iterator is allowed for a matrix if it has Accum or Write access. multiple Read iterators are permitted. so if you're reading, go wild, but if you're writing or accumulating, one at a time, bestie. don't be messy 💅

this is implemented in sc::BlockedSCVector, sc::ReplSCVector, sc::LocalSCVector, and sc::DistSCVector. so those are the ones that actually do the work.

👑 Author 👑

generated automatically by Doxygen for MPQC from the source code. so you know it's official, bestie. Doxygen is the real MVP for making these docs ✨

this page was brought to you by version 2.3.1, dated Sun Oct 4 2020 — periodt, it's iconic, it's legendary, it's giving documentation royalty 🌈👑💖

📦 where this page comes from