sc::NewtonOpt(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

🌸 NAME 🌸

Okay bestie, welcome to sc::NewtonOpt — this is the sc::NewtonOpt(3) page from the MPQC manual, so the manual name is folded in right at the top, iykyk. This class is the optimizer bestie we're talking about, and it's lowkey iconic.

✨ SYNOPSIS ✨

Inherits sc::Optimize.

🫶 Public Member Functions 🫶

  • NewtonOpt (const Ref< KeyVal > &) — constructor that takes a const Ref< KeyVal > &.
  • NewtonOpt (StateIn &) — constructor that takes a StateIn &.
  • void save_data_state (StateOut &) — saves the base classes (with save_data_state) and the members in the same order that the StateIn CTOR initializes them.
  • void init () — initializes the optimizer.
  • int update () — takes a step.

🔒 Protected Attributes 🔒

These are the protected attributes, exactly as listed — no extra lore added:

  • double maxabs_gradient
  • double accuracy_
  • int print_hessian_
  • int print_x_
  • int print_gradient_

🌈 Additional Inherited Members 🌈

Bestie, this section is here and it has no extra details listed in this manpage. The inherited members stay inherited — we're not inventing anything, periodt.

📚 Member Function Documentation 📚

void sc::NewtonOpt::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. The docs are very clear: this must be implemented by the derived class if the class has data. It's reimplemented from sc::SavableState. Slay.

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

This one takes a step. It returns 1 if the optimization has converged, otherwise 0. It implements sc::Optimize. That's the whole update vibe.

👑 Author 👑

Generated automatically by Doxygen for MPQC from the source code.

Catch you later, bestie 💖 — this page is from MPQC, Version 2.3.1, dated Sun Oct 4 2020, and it was generated automatically by Doxygen from the source code. Bye! 💅

📦 where this page comes from