sc::DFPUpdate(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

✨ NAME ✨

Okay bestie, welcome to sc::DFPUpdate(3) from the MPQC manual 💖. This page is all about the DFPUpdate class, which is used to specify a Davidson, Fletcher, and Powell hessian update scheme. Slay, we love a hessian update moment ✨.

🌸 SYNOPSIS 🌸

#include <update.h>

Inherits sc::HessianUpdate.

Inherited by sc::BFGSUpdate.

🌟 Public Member Functions 🌟

  • DFPUpdate (StateIn &)
  • DFPUpdate (const Ref< KeyVal > &) — The KeyVal constructor reads the following keywords:
  • 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)
  • void apply_transform (const Ref< NonlinearTransform > &)
  • void set_inverse ()

🛡️ Protected Attributes 🛡️

  • RefSCVector xprev
  • RefSCVector gprev

🫶 Additional Inherited Members 🫶

It says there are additional inherited members, but this doc doesn’t list extra details under that heading. Respectfully, that’s all she wrote 💅.

🦋 Detailed Description 🦋

The DFPUpdate class is used to specify a Davidson, Fletcher, and Powell hessian update scheme. Literally iconic behavior for a hessian update class 👑.

🧚 Constructor & Destructor Documentation 🧚

💖 sc::DFPUpdate::DFPUpdate (const Ref< KeyVal > &) 💖

The KeyVal constructor reads the following keywords:

  • xprev — The previous coordinates can be given (but is not recommended). The default is none.
  • gprev — The previous gradient can be given (but is not recommended). The default is none.
ngl, the docs really said “can be given (but is not recommended)” for both of these, so bestie… maybe just let the defaults do their thing 🙈.

🔥 Member Function Documentation 🔥

⭐ void sc::DFPUpdate::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::HessianUpdate.

Reimplemented in sc::BFGSUpdate.

🎀 Author 🎀

Generated automatically by Doxygen for MPQC from the source code.

okay that’s the whole page, bestie 💖 this one’s Version 2.3.1, dated Sun Oct 4 2020 — mwah, bye! 🫶

📦 where this page comes from