IMP::OptimizerState Class Reference

---

Detailed Description

Shared optimizer state.

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().

Examples: optimize em2d with montecarlo, write an optimizer state optimize em2d with montecarlo, write an optimizer state

Inheritance diagram for IMP::OptimizerState:

List of all members.

Public Member Functions
	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
std::size_t	__hash__ () const
virtual std::string	get_type_name () const =0
	Return a string identifying the type of the object.
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.
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< Optimizer >	optimizer_

Additional Inherited Members
Protected Member Functions inherited from IMP::base::Object
	Object (std::string name)

---

Member Function Documentation

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

virtual

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

Reimplemented in IMP::misc::DecayPairContainerOptimizerState, IMP::core::WriteRestraintScoresOptimizerState, and IMP::rmf::SaveOptimizerState.

virtual void IMP::OptimizerState::update ( )

pure virtual

Called when the Optimizer accepts a new conformation.

Implemented in IMP::atom::BerendsenThermostatOptimizerState, IMP::atom::LangevinThermostatOptimizerState, IMP::atom::VelocityScalingOptimizerState, IMP::atom::RemoveTranslationOptimizerState, IMP::atom::RemoveRigidMotionOptimizerState, IMP::container::PairsOptimizerState, IMP::container::QuadsOptimizerState, IMP::container::SingletonsOptimizerState, IMP::container::TripletsOptimizerState, IMP::container::EventPairsOptimizerState, IMP::container::EventQuadsOptimizerState, IMP::container::EventSingletonsOptimizerState, IMP::container::EventTripletsOptimizerState, IMP::misc::DecayPairContainerOptimizerState, IMP::core::WriteRestraintScoresOptimizerState, and IMP::rmf::SaveOptimizerState.

---

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

• OptimizerState.h