home | help
sc::IdentityTransform(3)	      MPQC		sc::IdentityTransform(3)

NAME
     sc::IdentityTransform  - The IdentityTransform is a special case of Nonlin-
     earTransform were no transformation takes place.

SYNOPSIS
     #include <transform.h>

     Inherits sc::NonlinearTransform.

   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.
     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.
     virtual void transform_coordinates (const RefSCVector &x)=0
	 Transform the coordinates.
     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.

     Public Member Functions inherited from sc::RefCount
     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.
     int managed () const
	 Return 1 if the object is managed. Otherwise return 0.

     Public Member Functions inherited from sc::Identity
     Identifier identifier ()
	 Return the Identifier for this argument.

   Additional Inherited Members
     Protected Member Functions inherited from sc::RefCount
     RefCount (const RefCount &)
     RefCount & operator= (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
   void sc::IdentityTransform::transform_coordinates  (const  RefSCVector  &  x)
     [virtual]
     These override the tranformation members of NonlinearTransform and do noth-
     ing.

     Implements sc::NonlinearTransform.

   void  sc::IdentityTransform::transform_gradient (const RefSCVector & g) [vir-
     tual]
     Transform the gradient at a point in  the	new  coordinate  system.  trans-
     form_coordinates must be called first to give the point.

     Reimplemented from sc::NonlinearTransform.

   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.

   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
     Generated automatically by Doxygen for MPQC from the source code.

Version 2.3.1			 Thu Sep 3 2026 	sc::IdentityTransform(3)

home | help