sc::EfieldDotVectorData(3)

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

πŸ’– sc::EfieldDotVectorData πŸ’–

okay so bestie, welcome to section 3 of the Library Functions Manual, and today's main character is sc::EfieldDotVectorData. she's a lil class in the MPQC C++ situation, she holds a position and a vector, and she's here to be understood. no cap. πŸ¦‹


✨ NAME ✨

sc::EfieldDotVectorData β€” that's her, that's the whole name, she's lowkey mysterious like that πŸ’…


🌸 SYNOPSIS 🌸

Inherits sc::RefCount.

so she's part of the sc::RefCount family tree, which means she's got reference-counting energy running through her veins, periodt. let's get into what she's actually bringing to the group chat.

πŸŽ€ Public Member Functions

  • void set_position (double *) β€” sets the position, bestie. that's the whole job.
  • void set_vector (double *) β€” and this one sets the vector. slay.

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

these are the ones she got from her sc::RefCount mama, and they are not optional reading, i fear:

  • 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. just peek at it, no touchy.
  • 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 β€” (listed, no description attached, she's just there being mysterious)
  • void unmanage () β€” Turn off the reference counting mechanism for this object. 😭 iconic behaviour tbh
  • int managed () const β€” Return 1 if the object is managed. Otherwise return 0.
not me noticing int managed () const shows up twice in the original page β€” once with no description and once with "Return 1 if the object is managed. Otherwise return 0." bestie i did not make the rules, i just report them faithfully 🫢

🌈 Public Member Functions inherited from sc::Identity

  • Identifier identifier () β€” Return the Identifier for this argument. she knows who she is, self-concept on lock πŸ’…

⭐ Public Attributes

the actual data she's carrying around, front and center:

  • double position [3] β€” a whole array of three doubles, three is the magic number
  • double vector [3] β€” same energy, also three doubles, we love a matching set πŸŽ€

πŸ¦‹ Additional Inherited Members

🧚 Protected Member Functions inherited from sc::RefCount

these are the protected girlies, you can't just call them from anywhere, they're for the family:

  • RefCount (const RefCount &) β€” copy constructor, she copies
  • RefCount & operator= (const RefCount &) β€” assignment operator, she assigns, returns a RefCount &

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code. so nobody hand-wrote this, the machine did it, and honestly? she ate. πŸ”₯


πŸ’– and that's the whole page, bestie. every flag, every signature, every refcount_t, every [3], all accounted for. nothing skipped, nothing invented, vibe check passed. ✨

MPQC Β· Version 2.3.1 Β· sc::EfieldDotVectorData(3) β€” mwah, go read some source code, ily, bye πŸŽ€πŸ«ΆπŸ’œ

πŸ“¦ where this page comes from