sc::Units(3)

💅 sc::Units(3) — MPQC manual page 💅

🌸 NAME 🌸

sc::Units — The Units class is used to perform unit converions.

---

✨ SYNOPSIS ✨

#include <units.h>

Inherits sc::SavableState.

---

🎀 Public Types 🎀

• enum Storage { Steal, Copy } — the two storage modes, bestie: Steal and Copy.

---

🦋 Public Member Functions 🦋

• Units (const char *strrep) — create using a string representation, like 'kcal/mol'.
• Units (char *strrep, Units::Storage=Units::Copy) — create using a string representation, like 'kcal/mol'. Default storage in the signature is Units::Copy.
• Units (StateIn &s) — restore the state of a Units object from s.
• double to (const Ref< Units > &u) const — the conversion factor from this to u.
• double from (const Ref< Units > &u) const — the conversion factor from u to this.
• double to_atomic_units () const — the conversion factor from this to atomic units.
• double from_atomic_units () const — the conversion factor from atom units to this.
• const char * string_rep () const — the string representation of the units.
• void save_data_state (StateOut &s) — save the state of the Units object to s.

---

🧚 Protected Member Functions 🧚

• void parse_unit () — protected member function listed on the page, with no extra description attached.

---

🍓 Protected Attributes 🍓

• char * strrep_ — protected attribute listed on the page, no extra description.
• double to_atomic_units_ — protected attribute listed on the page, no extra description.

---

🌈 Additional Inherited Members 🌈

This heading is present in the original page with no additional member details shown under it. So that's the whole section: acknowledged, not expanded, periodt.

---

💜 Detailed Description 💜

The Units class is used to perform unit converions. Yes, that's the exact word from the page — I'm not fixing it, I'm just handing you the tea 💅

---

👑 Constructor & Destructor Documentation 👑

sc::Units::Units (char * strrep, Units::Storage = Units::Copy)

Create using a string representation, like 'kcal/mol'. If Units::Steal is given as the second argument, the new Units object will delete the strrep argument when it is destroyed.

🚨 Steal-mode warning, bestie: if Units::Steal is the second argument, the new Units object will delete the strrep argument when it is destroyed.

---

⭐ Author ⭐

Generated automatically by Doxygen for MPQC from the source code.

---

Version 2.3.1 · Sun Oct 4 2020 — that's the footer, bestie, and the manual name is MPQC 🫶💖