sc::DipoleData(3)

πŸ“¦
version 2.3.1 Β· 4 versions
, in fedora 43, ubuntu noble

✨ NAME ✨</p>

sc::DipoleData β€” bestie, it's a little data-holder class for dipole stuff, and yes it's from the MPQC library, okurrr πŸ’…


🌈 SYNOPSIS 🌈

Inherits sc::RefCount. It's giving "I have a whole family tree of inherited powers" ✨

#include <sc/dipoledata.h>

🫢 Public Member Functions 🫢

  • DipoleData (double *d) β€” the constructor, takes a pointer to doubles, slays immediately πŸ’–
  • void set_origin (double *) β€” sets the origin, no cap

πŸ’œ Public Member Functions inherited from sc::RefCount πŸ’œ

The way this base class is carrying the entire reference-counting vibe, we love to see it πŸ‘‘

  • int lock_ptr () const β€” locks this object πŸ”’
  • int unlock_ptr () const β€” unlocks this object πŸ”“
  • void use_locks (bool inVal) β€” starts and stops using locks on this object
  • refcount_t nreference () const β€” returns the reference count, fr fr
  • refcount_t reference () β€” bumps the reference count up and hands you the new count ✨
  • refcount_t dereference () β€” decrements the reference count and returns the new count
  • int managed () const β€” classic
  • void unmanage () β€” turns OFF the reference counting mechanism for this object, like it said "I'm independent now, main character energy" πŸ’€
  • int managed () const β€” returns 1 if the object is managed, otherwise returns 0 (yes bestie, it's listed twice in the original and I'm not about to erase it, we keep the receipts) πŸ™ˆ

πŸ“ Public Member Functions inherited from sc::Identity πŸ“

  • Identifier identifier () β€” returns the Identifier for this argument πŸŽ€

⭐ Public Attributes ⭐

  • double origin [3] β€” a whole three-element array of doubles just sitting there being iconic

πŸ¦‹ Additional Inherited Members πŸ¦‹

Protected Member Functions inherited from sc::RefCount

  • RefCount (const RefCount &) β€” the copy constructor, protected so don't come for it
  • RefCount & operator= (const RefCount &) β€” the assignment operator, also protected, also minding its business

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code. Not me writing fanfic, it literally generated itself, that's the gag 😭


and that's the whole page bestie, go forth and dipole responsibly 🌈

okay so this was sc::DipoleData(3) from the MPQC Library Functions Manual, coming at you from MPQC Version 2.3.1 πŸ’– mwah, bye 🫢✨

πŸ“¦ where this page comes from