sc::IdentityTransform(3)

πŸ“¦
version 2.3.1 Β· 5 versions
, in ubuntu jammy

πŸ’… sc::IdentityTransform(3) πŸ’…

Okay so bestie, this is the MPQC manual page for sc::IdentityTransform(3). It's short, it's lowkey iconic, and it's giving main character who does absolutely nothing and still ate. No cap. πŸŽ€


πŸŽ€ NAME πŸŽ€

sc::IdentityTransform β€” the docs literally say: "The IdentityTransform is a special case of NonlinearTransform were no transformation takes place." So it's that special-case NonlinearTransform where no transforming happens. Yes, "were" is in the original; we keep the lore exact. πŸ’€

✨ SYNOPSIS ✨

#include <transform.h>

Inherits sc::NonlinearTransform.

πŸ’– Public Member Functions πŸ’–

  • void transform_coordinates (const RefSCVector &x) β€” the description says these override the tranformation members of NonlinearTransform and do nothing. Yep, tranformation is spelled that way in the original. We're not fixing it, bestie. 🫢
  • void transform_gradient (const RefSCVector &g) β€” transform the gradient at a point in the new coordinate system.
  • void transform_hessian (const RefSymmSCMatrix &h) β€” transform the hessian to the new coordinate system.
  • void transform_ihessian (const RefSymmSCMatrix &ih) β€” transform the inverse of the hessian.

🌸 Additional Inherited Members 🌸

The original page has this heading, and then... nothing under it. Empty. A little mysterious. We leave it exactly as the void intended. 🫧 iykyk.

πŸ¦‹ Detailed Description πŸ¦‹

sc::IdentityTransform is a special case of NonlinearTransform where no transformation takes place. The docs say "were" instead of "where"β€”iconic typo behaviorβ€”but the meaning is clear: this thing is a no-op transformation. It's literally the "do nothing" baddie of transforms. Ngl, that's a vibe. πŸ’…

πŸ”₯ Member Function Documentation πŸ”₯

🫢 transform_gradient 🫢

void sc::IdentityTransform::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.

Reimplemented from sc::NonlinearTransform.

πŸ’œ transform_hessian πŸ’œ

void sc::IdentityTransform::transform_hessian (const RefSymmSCMatrix & h)

[virtual]

Transform the hessian to the new coordinate system. transform_gradient must be called first to initialize this routine.

Reimplemented from sc::NonlinearTransform.

πŸ“ transform_ihessian πŸ“

void sc::IdentityTransform::transform_ihessian (const RefSymmSCMatrix & ih)

[virtual]

Transform the inverse of the hessian. transform_gradient must be called first to initialize this routine.

Reimplemented from sc::NonlinearTransform.

✨ Author ✨

Author: Generated automatically by Doxygen for MPQC from the source code. No human author energy here, just Doxygen doing its automatic thing. Fr fr. πŸ€–πŸ’–


Catch you later, bestie πŸ’– β€” this was the sc::IdentityTransform(3) page from the MPQC manual, version 2.3.1, dated Sun Oct 4 2020. Periodt. πŸŽ€βœ¨

πŸ“¦ where this page comes from