IMP  2.0.0
The Integrative Modeling Platform
IMP::core::Mover Class Referenceabstract

A base class for classes which perturb particles. More...

#include <IMP/core/Mover.h>

+ Inheritance diagram for IMP::core::Mover:

Public Member Functions

 Mover (Model *m, std::string name)
 
virtual ParticlesTemp get_output_particles () const =0
 Return the set of particles over which moves can be proposed.
 
virtual ParticlesTemp propose_move (Float size)=0
 
virtual void reset_move ()=0
 Roll back any changes made to the Particles.
 
- Public Member Functions inherited from IMP::core::MonteCarloMover
 MonteCarloMover (Model *m, std::string name)
 
void accept ()
 Roll back any changes made to the Particles.
 
MonteCarloMoverResult propose ()
 propose a modification More...
 
void reject ()
 Roll back any changes made to the Particles.
 
unsigned int get_number_of_proposed () const
 
unsigned int get_number_of_accepted () const
 
void reset_statistics ()
 
- 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 ModelObjectsTemp do_get_inputs () const
 
virtual MonteCarloMoverResult do_propose ()
 Implement propose_move()
 
virtual void do_reject ()
 Implement reset_proposed_move()
 
- Protected Member Functions inherited from IMP::core::MonteCarloMover
virtual void do_accept ()
 Implement accept_proposed_move(), default impl is empty.
 
virtual ModelObjectsTemp do_get_outputs () const
 
virtual void do_update_dependencies ()
 
- Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void update_dependencies ()
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 

Additional Inherited Members

Detailed Description

Mover objects are designed primarily to be used with the Monte Carlo optimizer. You probably want to use MoverBase if you are implementing a Mover.

See Also
MonteCarlo

Definition at line 27 of file Mover.h.

Member Function Documentation

virtual ModelObjectsTemp IMP::core::Mover::do_get_inputs ( ) const
protectedvirtual

Override if this reads other objects during evaluate.

Implements IMP::kernel::ModelObject.

Definition at line 41 of file Mover.h.

+ Here is the call graph for this function:


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