SC_REENTRANTUNCAPPEDTORUSHOLESHAPE(3)

πŸ“¦
version 2.3.1 Β· 5 versions
, in ubuntu jammy

πŸ¦‹ sc::ReentrantUncappedTorusHoleShape(3) πŸ¦‹

okay bestie, welcome to the MPQC manual page for sc::ReentrantUncappedTorusHoleShape. This class is lowkey the main character here, and I'm gonna walk you through every single thing the page says β€” no skips, no cap. ✨


✨ NAME ✨

sc::ReentrantUncappedTorusHoleShape β€” that's the class name, bestie. It's literally the whole NAME section, and it ate. πŸ’…

🌸 SYNOPSIS 🌸

Inherits sc::UncappedTorusHoleShape.

πŸ’– Public Member Functions πŸ’–

Here are the public member functions exactly as the page lists them, periodt:

ReentrantUncappedTorusHoleShape (double r, const SphereShape &, const
    SphereShape &)
int is_outside (const SCVector3 &r) const
double distance_to_surface (const SCVector3 &r, SCVector3 *grad=0) const
int gradient_implemented () const

Now the cute little breakdown:

  • the constructor β€” ReentrantUncappedTorusHoleShape takes a double r and two const SphereShape & arguments. The two SphereShape params are unnamed in the signature; I'm not sneaking names in, bestie. πŸ’–
  • is_outside β€” int is_outside (const SCVector3 &r) const. It takes a const SCVector3 &r, returns an int, and it's const. Iconic.
  • distance_to_surface β€” double distance_to_surface (const SCVector3 &r, SCVector3 *grad=0) const. It takes a const SCVector3 &r plus an optional SCVector3 *grad defaulting to 0, returns a double, and it's const.
  • gradient_implemented β€” int gradient_implemented () const. No arguments, returns an int, and it's const.

🫢 Additional Inherited Members 🫢

The page says there are Additional Inherited Members. That's the whole tea: they exist, they're inherited, and this page doesn't list them. iykyk. πŸ“

πŸ‘‘ Author πŸ‘‘

Generated automatically by Doxygen for MPQC from the source code.


okay that's the whole page, bestie. Cute sign-off time: Version 2.3.1, dated Sun Oct 4, from the MPQC source. Yep, the footer cuts off right there at Sun Oct 4, so that's all the date we got β€” no year, no cap, just vibes. πŸ’œβœ¨

πŸ“¦ where this page comes from