IMP logo
IMP Reference Guide  2.10.0
The Integrative Modeling Platform
IMP::container::SingletonsOptimizerState Class Reference

Apply a SingletonFunction to a SingletonContainer to maintain an invariant. More...

#include <IMP/container/SingletonsOptimizerState.h>

+ Inheritance diagram for IMP::container::SingletonsOptimizerState:

Detailed Description

Apply a SingletonFunction to a SingletonContainer to maintain an invariant.

See Also
SingletonOptimizerState

Definition at line 33 of file SingletonsOptimizerState.h.

Public Member Functions

 SingletonsOptimizerState (SingletonContainerAdaptor c, SingletonModifier *gf, std::string name="SingletonsOptimizerState %1%")
 
virtual std::string get_type_name () const
 
virtual ::IMP::VersionInfo get_version_info () const
 Get information about the module and version of the object. More...
 
virtual void update ()
 Called when the Optimizer accepts a new conformation. More...
 
- Public Member Functions inherited from IMP::OptimizerState
 OptimizerState (Model *m, std::string name)
 Constructor. More...
 
unsigned int get_number_of_updates () const
 Return the number of times do_update() has been called. More...
 
Optimizerget_optimizer () const
 
unsigned int get_period () const
 Get the periodicity of this state. More...
 
virtual void reset ()
 Reset counters, as if at the start of an optimize run. More...
 
virtual void set_is_optimizing (bool)
 Called by an Optimizer to signal begin/end of an optimize run. More...
 
void set_number_of_updates (unsigned int n)
 Set the counter of number of times do_update() has been called. More...
 
void set_period (unsigned int p)
 Set the periodicity of this state. More...
 
void update_always ()
 Force the state to perform its action now, ignoring the periodicity. More...
 
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed. More...
 
bool get_has_required_score_states () const
 Return whether score states are computed. More...
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 Get the interacting sets induced by this ModelObject. More...
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 Get the score states that are ancestors of this in the dependency graph. More...
 
void set_has_dependencies (bool tf)
 Either invalidate the dependencies or ensure they are correct. More...
 
void set_has_required_score_states (bool tf)
 Compute the required score states. More...
 
- Public Member Functions inherited from IMP::Object
virtual void clear_caches ()
 
CheckLevel get_check_level () const
 
LogLevel get_log_level () const
 
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)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::OptimizerState
virtual ModelObjectsTemp do_get_inputs () const
 
virtual ModelObjectsTemp do_get_outputs () const
 
virtual void do_set_is_optimizing (bool)
 
virtual void do_update (unsigned int)
 
- Protected Member Functions inherited from IMP::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
virtual void do_destroy ()
 

Constructor & Destructor Documentation

IMP::container::SingletonsOptimizerState::SingletonsOptimizerState ( SingletonContainerAdaptor  c,
SingletonModifier gf,
std::string  name = "SingletonsOptimizerState %1%" 
)
Parameters
[in]cThe Container to hold the elements to process
[in]gfThe SingletonModifier to apply to all elements.
[in]nameThe name to use for this Object

Member Function Documentation

virtual ::IMP::VersionInfo IMP::container::SingletonsOptimizerState::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 46 of file SingletonsOptimizerState.h.

virtual void IMP::container::SingletonsOptimizerState::update ( )
virtual

Called when the Optimizer accepts a new conformation.

This method is called by owning optimizers every time they commit. However, if set_period(p) was invoked, it calls do_update() only every p times it is called (by any optimizer).

Note
Overriding this method is deprecated; override do_update() instead.

Reimplemented from IMP::OptimizerState.


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