sc::Backtrack(3)

💅 sc::Backtrack — the manual page, but make it make sense

okay so bestie, welcome to sc::Backtrack, a whole class living inside the MPQC manual (section 3, iykyk) ✨ This page is literally just the class reference, and I'm gonna walk you through every single thing on it because we don't skip, ever.

---

🎀 NAME

sc::Backtrack — that's it, that's the name, that's the class 🫶

---

✨ SYNOPSIS

she's a class, and she inherits from sc::LineOpt — no cap, that's the whole vibe:

Inherits sc::LineOpt.

---

🌸 Public Member Functions

the public-facing bits, aka the parts you can actually touch:

• Backtrack (const Ref< KeyVal > &) — the constructor, takes a const Ref< KeyVal > & and that's literally all she needs 💅
• int update () — "Take a step." that's the description, verbatim, and honestly? iconic minimalism. more on her below 👇

---

🦋 Protected Attributes

protected means hands off unless you're in the family, bestie:

• double backtrack_factor_ — a double, and yes the trailing underscore is part of the name, don't come for her 🌈

---

🧚 Additional Inherited Members

there are more members, and they're inherited — i.e. they come from the parent class sc::LineOpt, not from Backtrack herself. the page doesn't list them out, it just tells you they're a thing, so that's exactly what I'm telling you 🎀

---

👑 Member Function Documentation

⭐ int sc::Backtrack::update () [virtual]

okay so this is the documented one, and here's the tea:

Take a step.

that's the whole description — she takes a step 🚶‍♀️ and:

• returns 1 if the optimization has converged
• otherwise returns 0

also she's [virtual], and she Implements sc::Optimize — so this is the class showing up and doing the job its parent promised it would do 💖

---

🙈 Author

Generated automatically by Doxygen for MPQC from the source code.

so like — nobody hand-wrote this page, Doxygen did it automatically from the MPQC source code. a bot wrote my source material, and honestly? relatable 😭

---

💜 the cute sign-off

that's the whole page, bestie — every member, every type, every "Take a step.", nothing dropped, periodt. this beauty is Version 2.3.1, dated Sun Oct 4 2020, and it lives at sc::Backtrack(3) in the MPQC manual. go forth and backtrack responsibly 🦋✨