sc::SteepestDescentOpt(3)

✨ NAME ✨

okay so bestie, this is the sc::SteepestDescentOpt(3) page from the MPQC manual 💅 and it's all about sc::SteepestDescentOpt — lowkey iconic, no cap.

🌈 SYNOPSIS 🌈

Inherits sc::Optimize.

🫶 Public Member Functions 🫶

• SteepestDescentOpt (const Ref< KeyVal > &) — here's the Ref< KeyVal >-taking signature, exactly as written, bestie. ✨
• SteepestDescentOpt (StateIn &) — and here's the StateIn &-taking signature too. 🫶
• void save_data_state (StateOut &) — Save the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. 📝
• void init () — Initialize the optimizer. ✨
• int update () — Take a step. 👟

🎀 Protected Attributes 🎀

• double maxabs_gradient — protected attribute, type double, name exactly maxabs_gradient. 🍓
• double accuracy_ — protected attribute, type double, name exactly accuracy_. 🍓
• Ref< LineOpt > lineopt_ — protected attribute, type Ref< LineOpt >, name exactly lineopt_. 🍓
• int take_newton_step_ — protected attribute, type int, name exactly take_newton_step_. 🍓
• int print_x_ — protected attribute, type int, name exactly print_x_. 🍓
• int print_gradient_ — protected attribute, type int, name exactly print_gradient_. 🍓

💜 Additional Inherited Members 💜

yep, this section title is literally here in the original — and that's it. No extra inherited-member deets are listed on this page, bestie. 🫶

🔥 Member Function Documentation 🔥

void sc::SteepestDescentOpt::save_data_state (StateOut &) [virtual]

okay so this one saves the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them. 🧚 This must be implemented by the derived class if the class has data. Reimplemented from sc::Optimize.

int sc::SteepestDescentOpt::update () [virtual]

Take a step. 👟 Returns 1 if the optimization has converged, otherwise 0. Implements sc::Optimize.

🌸 Author 🌸

Generated automatically by Doxygen for MPQC from the source code. 💀 slay, automation.

---

💖 later bestie — this MPQC manual page is Version 2.3.1, dated Sun Oct 4 2020. periodt.