MPQC 3.0.0-alpha
Loading...
Searching...
No Matches
sc::PowellUpdate Class Reference

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

#include <math/optimize/update.h>

Inheritance diagram for sc::PowellUpdate:
sc::HessianUpdate sc::SavableState sc::DescribedClass sc::RefCount

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 > &)
 
virtual void set_inverse ()
 
- Public Member Functions inherited from sc::SavableState
SavableStateoperator= (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.
 
- Public Member Functions inherited from sc::DescribedClass
 DescribedClass (const DescribedClass &)
 
DescribedClassoperator= (const DescribedClass &)
 
ClassDescclass_desc () const MPQC__NOEXCEPT
 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.
 
Ref< DescribedClassref ()
 Return this object wrapped up in a Ref smart pointer.
 
- 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.
 
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
 Return 1 if the object is managed. Otherwise return 0.
 

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 SavableStaterestore_state (StateIn &si)
 Restores objects saved with save_state.
 
static SavableStatekey_restore_state (StateIn &si, const char *keyword)
 Like restore_state, but keyword is used to override values while restoring.
 
static SavableStatedir_restore_state (StateIn &si, const char *objectname, 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 &)
 
RefCountoperator= (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 transition state searches (the EFCOpt class can be used for transition state searches).

Member Function Documentation

◆ apply_transform()

void sc::PowellUpdate::apply_transform ( const Ref< NonlinearTransform > & )
virtual

Reimplemented from sc::HessianUpdate.

◆ save_data_state()

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.

◆ update()

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

Implements sc::HessianUpdate.


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

Generated at Wed Sep 25 2024 02:45:34 for MPQC 3.0.0-alpha using the documentation package Doxygen 1.12.0.