IMP::core::PeriodicOptimizerState Class Referenceabstract
#include <IMP/core/PeriodicOptimizerState.h>
Inheritance diagram for IMP::core::PeriodicOptimizerState:Public Member Functions | |
| PeriodicOptimizerState (std::string name) | |
| unsigned int | get_number_of_updates () const |
| Return the number of times update has been called. | |
| unsigned int | get_period () const |
| virtual void | reset () |
| void | set_number_of_updates (unsigned int n) |
| Set the counter. | |
| void | set_period (unsigned int p) |
| void | update_always () |
| Public Member Functions inherited from IMP::kernel::OptimizerState | |
| OptimizerState (std::string name="OptimizerState %1%") | |
| Optimizer * | get_optimizer () const |
| virtual void | set_is_optimizing (bool) |
| virtual void | update ()=0 |
| Called when the Optimizer accepts a new conformation. | |
| Public Member Functions inherited from IMP::base::Object | |
| virtual void | clear_caches () |
| virtual IMP::base::VersionInfo | get_version_info () const =0 |
| Get information about the module and version of the object. | |
| void | set_check_level (CheckLevel l) |
| void | set_log_level (LogLevel l) |
| Set the logging level used in this object. More... | |
| void | set_was_used (bool tf) const |
| void | show (std::ostream &out=std::cout) const |
| const std::string & | get_name () const |
| void | set_name (std::string name) |
Protected Member Functions | |
| virtual void | do_update (unsigned int call_number)=0 |
Related Functions | |
(Note that these are not member functions.) | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < PeriodicOptimizerState > > | PeriodicOptimizerStatesTemp |
| Related Functions inherited from IMP::kernel::OptimizerState | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < OptimizerState > > | OptimizerStatesTemp |
| Related Functions inherited from IMP::base::Object | |
| typedef IMP::base::Vector < IMP::base::WeakPointer < Object > > | ObjectsTemp |
Additional Inherited Members | |
| Protected Attributes inherited from IMP::kernel::OptimizerState | |
| UncheckedWeakPointer< Optimizer > | optimizer_ |
Detailed Description
This optimizer state calls its do_update() method with a given period.
Definition at line 19 of file PeriodicOptimizerState.h.
Member Function Documentation
|
protectedpure virtual |
This method is called every get_period() update calls.
Implemented in IMP::rmf::SaveOptimizerState, IMP::misc::DecayPairContainerOptimizerState, and IMP::core::WriteRestraintScoresOptimizerState.
|
virtual |
Reset everything to look like the first call.
| void IMP::core::PeriodicOptimizerState::set_period | ( | unsigned int | p | ) |
Called when an optimization begins. It resets the current call number as well as making sure that the last frame is written.
| void IMP::core::PeriodicOptimizerState::update_always | ( | ) |
Force the optimizer state to perform its action now.
Friends And Related Function Documentation
|
related |
Pass a set of objects.
Definition at line 48 of file PeriodicOptimizerState.h.
The documentation for this class was generated from the following file: