IMP  2.0.1
The Integrative Modeling Platform
IMP::kernel::ScoreState Class Referenceabstract

ScoreStates maintian invariants in the Model. More...

#include <IMP/kernel/ScoreState.h>

+ Inheritance diagram for IMP::kernel::ScoreState:

Public Member Functions

 ScoreState (Model *m, std::string name="ScoreState %1%")
 
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed.
 
void before_evaluate ()
 Force update of the structure.
 
ContainersTemp get_input_containers () const
 
ParticlesTemp get_input_particles () const
 
ContainersTemp get_output_containers () const
 
ParticlesTemp get_output_particles () const
 
- Public Member Functions inherited from IMP::kernel::ModelObject
 ModelObject (Model *m, std::string name)
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
- 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_after_evaluate (DerivativeAccumulator *accpt)=0
 
virtual void do_before_evaluate ()=0
 
virtual void do_update_dependencies ()
 
- Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemp do_get_inputs () const =0
 
virtual ModelObjectsTemps do_get_interactions () const
 
virtual ModelObjectsTemp do_get_outputs () const =0
 
virtual void update_dependencies ()
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Related Functions

(Note that these are not member functions.)

typedef IMP::base::Vector
< IMP::base::WeakPointer
< ScoreState > > 
ScoreStatesTemp
 

Detailed Description

ScoreStates allow actions to be taken before and after the restraint evaluation process. Such code can be used to, for example:

  • log the optimization process
  • maintain constraints (see Constraint)

ScoreStates have two methods which are called during the Model::evaluate() function

  • before_evaluate() which is allowed to change the contents of containers and the value of attributes of particles and
  • after_evaluate() which can change particle derivatives

The Model uses information that the ScoreState reports about its input and output containers and particles to determine a safe order in which all the ScoreState objects registered in the model can be applied. That is, the Model will ensure that a ScoreState that has Particle A in its output list is applied before a ScoreState that has A in its input list. For ScoreState::before_evaluate(), Input and output lists are returned by the respective get_input_* and get_output_* calls. For ScoreState::after_evaluate() they are reversed (see note below).

Note
If no acceptable order exists, an exception will be thrown and the set of ScoreState objects creating the loop will be reported.
The input and output sets for the ScoreState::after_evaluate() functions are assumed to be the reverse of the ScoreState::before_evaluate() functions. As a result, the ScoreStates are applied in opposite order after evaluate. If you have a ScoreState for which this is not true, consider splitting it into two parts.

Definition at line 56 of file kernel/ScoreState.h.

Member Function Documentation

virtual void IMP::kernel::ScoreState::do_update_dependencies ( )
protectedvirtual

This method is called when the dependencies in the model have changed and model evaluate is called (or Model::ensure_dependencies()). The object can use this to update anything that is needed for efficient computation.

Reimplemented from IMP::kernel::ModelObject.

ContainersTemp IMP::kernel::ScoreState::get_input_containers ( ) const
ParticlesTemp IMP::kernel::ScoreState::get_input_particles ( ) const
ContainersTemp IMP::kernel::ScoreState::get_output_containers ( ) const
ParticlesTemp IMP::kernel::ScoreState::get_output_particles ( ) const

Friends And Related Function Documentation

Pass a set of objects.

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


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