sc::SCVector3(3)

🌸 sc::SCVector3 🌸 — Library Functions Manual

okay so bestie, welcome to sc::SCVector3 💖 it's a 3D vector class from MPQC, and this whole page is basically one giant SYNOPSIS flex. No long DESCRIPTION section, no vibes essay — just the full roster of constructors, operators and accessors, and we're gonna read every single one together. grab a strawberry 🍓, hydrate, and let's go.

---

✨ SYNOPSIS ✨

💅 Public Member Functions

• SCVector3 (const double p[3]) — build one straight out of a three-element double array. that's it, that's the constructor.
• SCVector3 (double d) — one double in, vector out.
• SCVector3 (double x, double y, double z) — the classic: three coords, one vector. main character energy 👑
• SCVector3 (const SCVector3 &p) — copy constructor, copying a SCVector3 from another SCVector3.
• SCVector3 (const RefSCVector &) — constructor taking a const RefSCVector &. no, the parameter has no name, that's just how it's written, don't @ me 💀
• SCVector3 (const Ref< KeyVal > &) — constructor taking a const Ref< KeyVal > &. also unnamed. iconic of them.
• void normalize () — the normalize call. it does the normalize thing, bestie.
• SCVector3 operator- () — unary minus, hands you back an SCVector3.
• SCVector3 operator* (double) const — multiply by a double, get an SCVector3 back. const-qualified, so it behaves. 🎀
• void operator= (const double *x) — assignment from a const double * named x.
• void operator= (const SCVector3 &x) — assignment from another SCVector3 named x.
• void operator= (double d) — assignment from a plain double named d.
• void operator-= (const SCVector3 &v) — subtract-and-assign, other vector is v.
• void operator+= (const SCVector3 &v) — add-and-assign, other vector is v.
• void operator*= (double m) — multiply-and-assign by m.
• SCVector3 operator+ (const SCVector3 &v) const — vector plus vector, returns a fresh SCVector3, and it's const so it won't touch anything. 🫶
• SCVector3 operator- (const SCVector3 &v) const — vector minus vector, also const, also returns an SCVector3.
• double dot (const SCVector3 &v) const — the dot one. takes a const SCVector3 &v, gives you a double. the name is literally the description, iykyk.
• SCVector3 cross (const SCVector3 &) const — the cross one. takes an unnamed const SCVector3 &, returns an SCVector3.
• SCVector3 perp_unit (const SCVector3 &) const — perp_unit, taking an unnamed const SCVector3 &, returning an SCVector3. no cap.
• void spherical_coord (double theta, double phi, double r) — sets spherical coords from theta, phi and r. note the order: theta, phi, r. don't flip it bestie 😭
• void spherical_to_cartesian (SCVector3 &cart) const — converts to cartesian, dropping the result into the SCVector3 &cart you pass in. const method, so it's not messing with itself.
• double maxabs () const — maxabs, returns a double.
• double dist (const SCVector3 &) const — distance to another (unnamed) SCVector3, returns a double.
• void rotate (double theta, SCVector3 &v) — rotate by theta with an SCVector3 &v along for the ride.
• double norm () const — norm, returns a double. we love a const method 💜
• double & elem (int xyz) — grab an element by index xyz, and you get a double & back. a real reference. handle with care.
• const double & elem (int xyz) const — the const overload: index xyz, const double & back. no touching.
• double & operator[] (int i) — bracket access with index i, returns double &. slay.
• const double & operator[] (int i) const — const bracket access, const double & back.
• double & operator() (int i) — call-operator access with index i, returns double &.
• const double & operator() (int i) const — const call-operator access, const double & back.
• const double * data () const — hands you a const double * to the underlying data. read-only situation.
• double * data () — the non-const data (), hands you a plain double *. yes bestie, that's a writable pointer. be normal about it 🙈
• double & x () — reference to x.
• double & y () — reference to y.
• double & z () — reference to z.
• const double & x () const — const reference to x.
• const double & y () const — const reference to y.
• const double & z () const — const reference to z.
• double & r () — reference to r.
• double & theta () — reference to theta.
• double & phi () — reference to phi.
• const double & r () const — const reference to r.
• const double & theta () const — const reference to theta.
• const double & phi () const — const reference to phi.
• void print (std::ostream &=ExEnv::out0()) const — print it out, with the stream defaulting to ExEnv::out0(). note the &= in the signature, that's exactly how it's written, copy it character for character or perish 💅

every single one of these is const-qualified or not exactly as listed — the const-ness is part of the contract, so don't go assuming you can mutate through the const ones. nope. not today. ✨

🫶 Friends

• class SCMatrix3 — yes, SCMatrix3 is a friend. the friendship is canon, it's right there in the synopsis. 🌈

---

👑 Author

Generated automatically by Doxygen for MPQC from the source code. not a human, just a little robot that reads headers and writes manpages 🧚

---

and that's the whole page bestie, we ate and left no crumbs 💅 this was sc::SCVector3(3) from the MPQC Library Functions Manual, Version 2.3.1 — go forth and vector responsibly 🦋⭐