MPQC  3.0.0-alpha
sc::IdentityTransform Class Reference

The IdentityTransform is a special case of NonlinearTransform were no transformation takes place. More...

#include <math/optimize/transform.h>

Inheritance diagram for sc::IdentityTransform:
sc::NonlinearTransform sc::RefCount

Public Member Functions

void transform_coordinates (const RefSCVector &x)
 These override the tranformation members of NonlinearTransform and do nothing.
 
void transform_gradient (const RefSCVector &g)
 Transform the gradient at a point in the new coordinate system. More...
 
void transform_hessian (const RefSymmSCMatrix &h)
 Transform the hessian to the new coordinate system. More...
 
void transform_ihessian (const RefSymmSCMatrix &ih)
 Transform the inverse of the hessian. More...
 
- Public Member Functions inherited from sc::RefCount
size_t identifier () const
 Return the unique identifier for this object that can be compared for different objects of different types. More...
 
int lock_ptr () const
 Lock this object.
 
int unlock_ptr () const
 Unlock this object.
 
void use_locks (bool inVal)
 start and stop using locks on this object
 
refcount_t nreference () const
 Return the reference count.
 
refcount_t reference ()
 Increment the reference count and return the new count.
 
refcount_t dereference ()
 Decrement the reference count and return the new count.
 
int managed () const
 
void unmanage ()
 Turn off the reference counting mechanism for this object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from sc::RefCount
 RefCount (const RefCount &)
 
RefCountoperator= (const RefCount &)
 
- Protected Attributes inherited from sc::NonlinearTransform
RefSCMatrix linear_transform_
 

Detailed Description

The IdentityTransform is a special case of NonlinearTransform were no transformation takes place.

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.


The documentation for this class was generated from the following file:

Generated at Sun Jan 26 2020 23:24:06 for MPQC 3.0.0-alpha using the documentation package Doxygen 1.8.16.