SCExtrapError holds the error data needed by SelfConsistentExtrapolation. More...
#include <math/optimize/scextrap.h>
Public Member Functions | |
| SCExtrapError () | |
| Construct a new SCExtrapError. | |
| SCExtrapError (StateIn &) | |
| Constructor to restore SCExtrapError from a StateIn object. | |
| 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 double | error ()=0 |
| Returns some measure of the total error. | |
| virtual double | scalar_product (const Ref< SCExtrapError > &)=0 |
| Performs a scalar product between this and the given SCExtrapError. | |
 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. | |
| Public Member Functions inherited from sc::DescribedClass | |
| DescribedClass (const DescribedClass &) | |
| DescribedClass & | operator= (const DescribedClass &) |
| ClassDesc * | class_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< DescribedClass > | ref () |
| 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. | |
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 *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 &) | |
| RefCount & | operator= (const RefCount &) |
Detailed Description
SCExtrapError holds the error data needed by SelfConsistentExtrapolation.
Member Function Documentation
◆ error()
|
pure virtual |
Returns some measure of the total error.
Implemented in sc::sma2::Array24SCExtrapError, sc::sma2::Array2SCExtrapError, sc::sma2::Array4SCExtrapError, sc::sma2::Array6SCExtrapError, sc::SymmSCMatrixSCExtrapError, and sc::TensorExtrapError.
◆ save_data_state()
|
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::SavableState.
Reimplemented in sc::sma2::Array24SCExtrapError, sc::sma2::Array2SCExtrapError, sc::sma2::Array4SCExtrapError, sc::sma2::Array6SCExtrapError, sc::SymmSCMatrixSCExtrapError, and sc::TensorExtrapError.
◆ scalar_product()
|
pure virtual |
Performs a scalar product between this and the given SCExtrapError.
Implemented in sc::sma2::Array24SCExtrapError, sc::sma2::Array2SCExtrapError, sc::sma2::Array4SCExtrapError, sc::sma2::Array6SCExtrapError, sc::SymmSCMatrixSCExtrapError, and sc::TensorExtrapError.
The documentation for this class was generated from the following file:
- src/lib/math/optimize/scextrap.h