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

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

#include <IMP/core/MonteCarloMover.h>

+ Inheritance diagram for IMP::core::MonteCarloMover:

Public Member Functions

 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.
 
- 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_accept ()
 Implement accept_proposed_move(), default impl is empty.
 
virtual ModelObjectsTemp do_get_outputs () const
 
virtual MonteCarloMoverResult do_propose ()=0
 Implement propose_move()
 
virtual void do_reject ()=0
 Implement reset_proposed_move()
 
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 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
< MonteCarloMover > > 
MonteCarloMoversTemp
 

Statistics

Movers keep track of some statistics as they are used.

unsigned int get_number_of_proposed () const
 
unsigned int get_number_of_accepted () const
 
void reset_statistics ()
 

Detailed Description

Mover objects propose a move, which can then be either accepted or rejected based on some criteria. For example, in a Monte-Carlo evaluation scheme.

The output particles (ModelObject::do_get_outputs()) are assummed to be equal to the inputs (ModelObject::do_get_inputs()).

Definition at line 38 of file MonteCarloMover.h.

Member Function Documentation

virtual ModelObjectsTemp IMP::core::MonteCarloMover::do_get_outputs ( ) const
protectedvirtual

Override if this writes other objects during evaluate.

Implements IMP::kernel::ModelObject.

Definition at line 94 of file MonteCarloMover.h.

+ Here is the call graph for this function:

virtual void IMP::core::MonteCarloMover::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.

Definition at line 98 of file MonteCarloMover.h.

MonteCarloMoverResult IMP::core::MonteCarloMover::propose ( )

The method should return the list of all particles that were actually moved and the ratio between the backward move probability and the forward move probability (for Metropolis-Hastings moves). Just return 1.0 for this value if you are not sure.

Definition at line 51 of file MonteCarloMover.h.

+ Here is the call graph for this function:

Friends And Related Function Documentation

Pass a set of objects.

Definition at line 101 of file MonteCarloMover.h.


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