IMP logo
IMP Reference Guide  develop.29b24c6ad6,2021/05/15
The Integrative Modeling Platform
IMP::kinematics::KinematicForestScoreState Class Reference

#include <IMP/kinematics/KinematicForestScoreState.h>

+ Inheritance diagram for IMP::kinematics::KinematicForestScoreState:

Detailed Description

A score state that uses a KinematicForest of the model to update external coordinates before energy evaluation, if internal coordinates in the forest were altered previously.

See Also
KinematicForest
Joint

Definition at line 41 of file KinematicForestScoreState.h.

Public Member Functions

 KinematicForestScoreState (KinematicForest *kf, IMP::core::RigidBodies rbs, IMP::ParticlesTemp atoms)
 
void do_after_evaluate (DerivativeAccumulator *da)
 Do any necessary updates after the model score is calculated. More...
 
void do_before_evaluate ()
 Update the state given the current state of the model. More...
 
ModelObjectsTemp do_get_inputs () const
 
ModelObjectsTemp do_get_outputs () const
 
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...
 
- Public Member Functions inherited from IMP::ScoreState
 ScoreState (Model *m, std::string name)
 
void after_evaluate (DerivativeAccumulator *accpt)
 Do post evaluation work if needed. More...
 
void before_evaluate ()
 Force update of the structure. 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::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 ()
 

Member Function Documentation

void IMP::kinematics::KinematicForestScoreState::do_after_evaluate ( DerivativeAccumulator accpt)
virtual

Do any necessary updates after the model score is calculated.

Parameters
[in]accptThe object used to scale derivatives in the score calculation, or nullptr if derivatives were not requested.

Implements IMP::ScoreState.

Definition at line 55 of file KinematicForestScoreState.h.

void IMP::kinematics::KinematicForestScoreState::do_before_evaluate ( )
virtual

Update the state given the current state of the model.

This is also called prior to every calculation of the model score. It should be implemented by ScoreStates in order to provide functionality.

Implements IMP::ScoreState.

Definition at line 53 of file KinematicForestScoreState.h.

ModelObjectsTemp IMP::kinematics::KinematicForestScoreState::do_get_inputs ( ) const
virtual

Get any Particle, Container or other ModelObjects read by this during evaluation. If you read everything in a container, you can just return that container.

Implements IMP::ModelObject.

ModelObjectsTemp IMP::kinematics::KinematicForestScoreState::do_get_outputs ( ) const
virtual

Get any Particle, Container or other ModelObjects changed by this during evaluation. This is only useful for ScoreStates, at the moment.

Implements IMP::ModelObject.

virtual ::IMP::VersionInfo IMP::kinematics::KinematicForestScoreState::get_version_info ( ) const
virtual

Get information about the module and version of the object.

Reimplemented from IMP::Object.

Definition at line 43 of file KinematicForestScoreState.h.


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