sc::NonlinearTransform(3)

📦
version 2.3.1 · 5 versions
, in ubuntu jammy

okay bestie, welcome to the sc::NonlinearTransform(3) page in the MPQC manual 💖✨ this one is lowkey a class page, not a command, and it's giving coordinate glow-up energy.

🌸 NAME 🌸

sc::NonlinearTransform — The NonlinearTransform class transforms between two nonlinear coordinate systems. periodt 💅

✨ SYNOPSIS ✨

#include <transform.h>
  • Inherits sc::RefCount.
  • Inherited by sc::IdentityTransform.

💖 Public Member Functions 💖

  • virtual void transform_coordinates (const RefSCVector &x)=0 — Transform the coordinates. yes, the =0 is literally right there, iykyk 👀
  • virtual void transform_gradient (const RefSCVector &g) — Transform the gradient at a point in the new coordinate system.
  • virtual void transform_hessian (const RefSymmSCMatrix &h) — Transform the hessian to the new coordinate system.
  • virtual void transform_ihessian (const RefSymmSCMatrix &ih) — Transform the inverse of the hessian.

🛡️ Protected Attributes 🛡️

  • RefSCMatrix linear_transform_ — the one protected attribute listed here, no cap 🫶

👑 Additional Inherited Members 👑

yup, the page has an Additional Inherited Members heading and literally no extra list under it. that's the whole vibe check, bestie 💀

🌟 Detailed Description 🌟

The NonlinearTransform class transforms between two nonlinear coordinate systems. It is needed when a change of coordinates occurs in the middle of an optimization. iconic behavior, honestly 🔥

💅 Member Function Documentation 💅

🔥 sc::NonlinearTransform::transform_gradient 🔥

virtual void sc::NonlinearTransform::transform_gradient (const RefSCVector &
       g) [virtual]

Transform the gradient at a point in the new coordinate system. transform_coordinates must be called first to give the point. the way that pre-req chain is giving main character energy, ngl ✨

Reimplemented in sc::IdentityTransform.

🔥 sc::NonlinearTransform::transform_hessian 🔥

virtual void sc::NonlinearTransform::transform_hessian (const
       RefSymmSCMatrix & h) [virtual]

Transform the hessian to the new coordinate system. transform_gradient must be called first to initialize this routine. fr fr, don't skip that step 😭

Reimplemented in sc::IdentityTransform.

🔥 sc::NonlinearTransform::transform_ihessian 🔥

virtual void sc::NonlinearTransform::transform_ihessian (const
       RefSymmSCMatrix & ih) [virtual]

Transform the inverse of the hessian. transform_gradient must be called first to initialize this routine. same energy as above, bestie 💜

Reimplemented in sc::IdentityTransform.

✨ Author ✨

Generated automatically by Doxygen for MPQC from the source code. slay 💅

this page is from the MPQC source, version 2.3.1, dated Sun Oct 4 2020 — bye bestie, mwah 💜🫶

📦 where this page comes from