sc::RefSCVector(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

💅 sc::RefSCVector — from the MPQC manual, section 3

okay so bestie, buckle up — this is the page for sc::RefSCVector, and yes it lives in section 3 of the MPQC manual. it's a whole vibe. let's go 🫶

✨ NAME ✨

sc::RefSCVector — the RefSCVector class is a smart pointer to an SCVector specialization. that's it, that's the whole name section, and it ate 💅

🦋 SYNOPSIS 🦋

#include <matrix.h>

Inherits sc::Ref< SCVector >. yes bestie, it's a Ref, it's giving "I hold a pointer and I'm responsible about it" ✨

🌸 Public Member Functions 🌸

  • RefSCVector () — initializes the vector pointer to 0. starts out as a literal nobody, no cap.
  • RefSCVector (const RefSCVector &v) — make this and v refer to the same SCVector. sharing is caring 💖
  • RefSCVector (SCVector *v) — make this refer to v.
  • RefSCVector & operator= (SCVector *v) — make this refer to v.
  • RefSCVector & operator= (const RefSCVector &v) — make this and v refer to the same SCVector. matchy matchy 🎀
  • RefSCVector (const RefSCDimension &dim, const Ref< SCMatrixKit > &) — create a vector with dimension dim.
  • SCVectordouble operator() (int) const — return an l-value that can be used to assign or retrieve an element. index era 👑
  • SCVectordouble operator[] (int) const — return an l-value that can be used to assign or retrieve an element. same energy, different brackets 🦋
  • RefSCVector operator+ (const RefSCVector &a) const — add two vectors. math besties rise 💀
  • RefSCVector operator- (const RefSCVector &a) const — subtract two vectors.
  • RefSCVector operator* (double) const — scale a vector.
  • RefSCMatrix outer_product (const RefSCVector &v) const — return the outer product between this and v.
  • RefSymmSCMatrix symmetric_outer_product () const — the outer product of this with itself is a symmetric matrix. iconic self-love moment 💜
  • void set_element (int i, double val) const
  • void accumulate_element (int i, double val) const
  • double get_element (int) const
  • int n () const
  • RefSCDimension dim () const
  • Ref< SCMatrixKit > kit () const
  • RefSCVector clone () const
  • RefSCVector copy () const
  • double maxabs () const
  • double scalar_product (const RefSCVector &) const
  • double dot (const RefSCVector &) const
  • void normalize () const
  • void randomize () const
  • void assign (const RefSCVector &v) const
  • void assign (double val) const
  • void assign (const double *v) const
  • void convert (double *) const
  • void scale (double val) const
  • void accumulate (const RefSCVector &v) const
  • void accumulate_product (const RefSymmSCMatrix &, const RefSCVector &)
  • void accumulate_product (const RefSCMatrix &, const RefSCVector &)
  • void element_op (const Ref< SCElementOp > &op) const
  • void element_op (const Ref< SCElementOp2 > &, const RefSCVector &) const
  • void element_op (const Ref< SCElementOp3 > &, const RefSCVector &, const RefSCVector &) const
  • void print (std::ostream &out) const
  • void print (const char *title=0, std::ostream &out=ExEnv::out0(), int precision=10) const
  • void save (StateOut &)
  • void restore (StateIn &) — restores the matrix from StateIn object. the vector must have been initialized already. 🙈 not me warning you twice, but like, it matters.

🌈 Additional Inherited Members 🌈

there's more stuff inherited from the parent class, bestie — you get the whole bloodline, iykyk.

💖 Detailed Description 💖

The RefSCVector class is a smart pointer to an SCVector specialization.

literally that's the description. short, sweet, main character energy. ⭐

🧚 Constructor & Destructor Documentation 🧚

sc::RefSCVector::RefSCVector ()

Initializes the vector pointer to 0. so it's starting from nothing, and — important — the reference must be initialized before it is used. no vibes-only pointers, okay? initialize first, slay second 💅

sc::RefSCVector::RefSCVector (const RefSCDimension & dim, const Ref< SCMatrixKit > &)

Create a vector with dimension dim. and heads up: the data values are undefined — like genuinely undefined, not "probably zero." don't be out here assuming anything about them, bestie 😭

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code. no human wrote this, it's a Doxygen robot, and honestly it ate 🤖✨

okay that's the whole page!! and a lil cute sign-off for you: this is Version 2.3.1, dated Sun Oct 4 2020, and you can find it filed under sc::RefSCVector(3). mwah, go forth and initialize your references 💜🎀🦋

📦 where this page comes from