sc::BFGSUpdate(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

okay so this is the sc::BFGSUpdate(3) page from the MPQC manual, and it’s literally all about that BFGS hessian update vibe. 💅

🌸 NAME 🌸

sc::BFGSUpdate — The DFPUpdate class is used to specify a Broyden, Fletcher, Goldfarb, and Shanno hessian update scheme.

✨ SYNOPSIS ✨

#include <update.h>

Inherits sc::DFPUpdate.

🎀 PUBLIC MEMBER FUNCTIONS 🎀

  • BFGSUpdate (StateIn &) — constructor that takes a StateIn &.
  • BFGSUpdate (const Ref< KeyVal > &) — constructor that takes a const Ref< KeyVal > &.
  • 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 update (const RefSymmSCMatrix &ihessian, const Ref< Function > &, const RefSCVector &xnew, const RefSCVector &gnew) — the page lists this signature with no extra description in this list. 🫶

🦋 ADDITIONAL INHERITED MEMBERS 🦋

The page just has this heading — no extra members are spelled out in this section.

💜 DETAILED DESCRIPTION 💜

The page says: “The DFPUpdate class is used to specify a Broyden, Fletcher, Goldfarb, and Shanno hessian update scheme.” 💖

This hessian update method is the recommended method for use with QNewtonOpt objects. 👑

🔥 MEMBER FUNCTION DOCUMENTATION 🔥

💅 void sc::BFGSUpdate::save_data_state (StateOut &) [virtual] 💅

Save 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::DFPUpdate.

🌈 AUTHOR 🌈

Generated automatically by Doxygen for MPQC from the source code.

xoxo, bestie 💖 — that was Version 2.3.1, dated Sun Oct 4 2020, from the MPQC source code. Go get that hessian update, periodt. 💅✨

📦 where this page comes from