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

NAME
     sc::PowellUpdate - The PowellUpdate class is used to specify a Powell hess-
     ian update.

SYNOPSIS
     #include <update.h>

     Inherits sc::HessianUpdate.

   Public Member Functions
     PowellUpdate (StateIn &)
     PowellUpdate (const Ref< KeyVal > &)
     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 >  &func,
	 const RefSCVector &xnew, const RefSCVector &gnew)
     void apply_transform (const Ref< NonlinearTransform > &)

     Public Member Functions inherited from sc::HessianUpdate
     HessianUpdate (StateIn &)
     HessianUpdate (const Ref< KeyVal > &)
     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.
     virtual void update (const RefSymmSCMatrix &hessian, const Ref< Function  >
	 &, const RefSCVector &xnew, const RefSCVector &gnew)=0
     virtual void set_inverse ()
     virtual void apply_transform (const Ref< NonlinearTransform > &)

     Public Member Functions inherited from sc::SavableState
     SavableState & operator= (const SavableState &)
     void save_state (StateOut &)
	 Save the state of the object as specified by the StateOut object.
     void save_object_state (StateOut &)
	 This  can be used for saving state when the exact type of the object is
	 known for both the save and the restore.
     virtual void save_vbase_state (StateOut &)
	 Save the virtual bases for the object.
     virtual 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.

     Public Member Functions inherited from sc::DescribedClass
     DescribedClass (const DescribedClass &)
     DescribedClass & operator= (const DescribedClass &)
     ClassDesc * class_desc () const  throw ()
	 This  returns	the unique pointer to the ClassDesc corresponding to the
	 given type_info object.
     const char * class_name () const
	 Return the name of the object's exact type.
     int class_version () const
	 Return the version of the class.
     virtual void print (std::ostream &=ExEnv::out0()) const
	 Print the object.

     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.

   Protected Attributes
     RefSCVector xprev
     RefSCVector gprev

     Protected Attributes inherited from sc::HessianUpdate
     int inverse_hessian_

   Additional Inherited Members
     Static Public Member Functions inherited from sc::SavableState
     static void save_state (SavableState *s, StateOut &)
     static SavableState * restore_state (StateIn &si)
	 Restores objects saved with save_state.
     static SavableState * key_restore_state (StateIn &si, const char *keyword)
	 Like restore_state, but  keyword  is  used  to  override  values  while
	 restoring.
     static  SavableState  * dir_restore_state (StateIn &si, const char *object-
	 name, const char *keyword=0)

     Protected Member Functions inherited from sc::SavableState
     SavableState (const SavableState &)
     SavableState (StateIn &)
	 Each derived class StateIn CTOR handles the  restore  corresponding  to
	 calling save_object_state, save_vbase_state, and save_data_state listed
	 above.

     Protected Member Functions inherited from sc::RefCount
     RefCount (const RefCount &)
     RefCount & operator= (const RefCount &)

Detailed Description
     The PowellUpdate class is used to specify a Powell hessian update.

     This  hessian  update method is the recommended method for use with transi-
     tion state searches (the EFCOpt class can	be  used  for  transition  state
     searches).

Member Function Documentation
   void  sc::PowellUpdate::apply_transform  (const  Ref< NonlinearTransform > &)
     [virtual]
     Reimplemented from sc::HessianUpdate.

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

   void sc::PowellUpdate::update (const RefSymmSCMatrix & ihessian,  const  Ref<
     Function  >  &  func,  const  RefSCVector & xnew, const RefSCVector & gnew)
     [virtual]
     Implements sc::HessianUpdate.

Author
     Generated automatically by Doxygen for MPQC from the source code.

Version 2.3.1			 Thu Sep 3 2026 	     sc::PowellUpdate(3)
home | help