IMP  2.0.0
The Integrative Modeling Platform
IMP::kernel::OptimizerState Class Referenceabstract

Shared optimizer state. More...

#include <IMP/kernel/OptimizerState.h>

+ Inheritance diagram for IMP::kernel::OptimizerState:

Public Member Functions

 OptimizerState (std::string name="OptimizerState %1%")
 
Optimizerget_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 Attributes

UncheckedWeakPointer< Optimizeroptimizer_
 

Related Functions

(Note that these are not member functions.)

typedef IMP::base::Vector
< IMP::base::WeakPointer
< OptimizerState > > 
OptimizerStatesTemp
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Detailed Description

The OptimizerState update method is called each time the Optimizer commits to a new set of coordinates. Optimizer states may change the values of particle attributes. However, changes to whether an attribute is optimized or not may not be picked up by the Optimizer until the next call to optimize.

Note
When logging is VERBOSE, state should print enough information in evaluate to reproduce the the entire flow of data in update. When logging is TERSE the restraint should print out only a constant number of lines per update call.

Implementors should see IMP_OPTIMIZER_STATE().

Definition at line 38 of file kernel/OptimizerState.h.

Member Function Documentation

virtual void IMP::kernel::OptimizerState::set_is_optimizing ( bool  )
virtual

Called with true at the beginning of an optimizing run and with false at the end.

Definition at line 50 of file kernel/OptimizerState.h.

Friends And Related Function Documentation

Pass a set of objects.

Definition at line 84 of file kernel/base_types.h.


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