IMP  2.1.1
The Integrative Modeling Platform
IMP::core::SerialMover Class Reference

Apply a list of movers one at a time. More...

#include <IMP/core/SerialMover.h>

+ Inheritance diagram for IMP::core::SerialMover:

Public Member Functions

 SerialMover (const MonteCarloMoversTemp &mvs)
 
double get_acceptance_probability (int i) const
 
const MonteCarloMoversget_movers () const
 
unsigned int get_number_of_movers () const
 
virtual std::string get_type_name () const
 
virtual ::IMP::base::VersionInfo get_version_info () const
 Get information about the module and version of the object.
 
void reset_acceptance_probabilities ()
 
- Public Member Functions inherited from IMP::core::MonteCarloMover
 MonteCarloMover (kernel::Model *m, std::string name)
 
void accept ()
 Roll back any changes made to the kernel::Particles.
 
MonteCarloMoverResult propose ()
 propose a modification More...
 
void reject ()
 Roll back any changes made to the kernel::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 (kernel::Model *m, std::string name)
 
 ModelObject (std::string name)
 
virtual void do_set_model (kernel::Model *)
 
bool get_has_dependencies () const
 Return whether this object has dependencies computed.
 
bool get_has_required_score_states () const
 
ModelObjectsTemp get_inputs () const
 
ModelObjectsTemps get_interactions () const
 
bool get_is_part_of_model () const
 
Modelget_model () const
 
ModelObjectsTemp get_outputs () const
 
const ScoreStatesTempget_required_score_states () const
 
void set_has_dependencies (bool tf)
 
void set_has_required_score_states (bool tf)
 
virtual void set_model (kernel::Model *m)
 
- Public Member Functions inherited from IMP::base::Object
virtual void clear_caches ()
 
virtual void do_destroy ()
 
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)
 

Protected Member Functions

virtual void do_accept ()
 Implement accept_proposed_move(), default impl is empty.
 
virtual kernel::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 kernel::ModelObjectsTemp do_get_outputs () const
 
- Protected Member Functions inherited from IMP::kernel::ModelObject
virtual ModelObjectsTemps do_get_interactions () const
 
virtual void handle_set_has_required_score_states (bool)
 
- Protected Member Functions inherited from IMP::base::Object
 Object (std::string name)
 Construct an object with the given name. More...
 
 Object ()
 

Detailed Description

Each time a move is requested, on the next mover is applied. This should probably be used in conjunction with incremental scoring (MonteCarlo::set_use_incremental()).

Definition at line 23 of file SerialMover.h.

Constructor & Destructor Documentation

IMP::core::SerialMover::SerialMover ( const MonteCarloMoversTemp mvs)

The Serial are applied one at a time

Parameters
[in]mvslist of movers to apply one after another

Member Function Documentation

virtual kernel::ModelObjectsTemp IMP::core::SerialMover::do_get_inputs ( ) const
protectedvirtual

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::kernel::ModelObject.

double IMP::core::SerialMover::get_acceptance_probability ( int  i) const
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the functions on the individual movers.
unsigned int IMP::core::SerialMover::get_number_of_movers ( ) const
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the functions on the individual movers.
void IMP::core::SerialMover::reset_acceptance_probabilities ( )
Deprecated:
As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use the functions on the individual movers.

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