 |
A base class for classes which perturb particles.
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.
Inheritance diagram for IMP::core::Mover:Public Member Functions | |
| Mover (Model *m, std::string name) | |
| Optimizer * | get_optimizer () const |
| Get a pointer to the optimizer which has this mover. | |
| 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 |
| propose a modification | |
| virtual void | reset_move ()=0 |
| Roll back any changes made to the Particles. | |
| Public Member Functions inherited from IMP::ModelObject | |
| ModelObject (Model *m, std::string name) | |
| ModelObjectsTemp | get_inputs () const |
| Model * | get_model () const |
| ModelObjectsTemp | get_outputs () const |
| Public Member Functions inherited from IMP::base::Object | |
| std::size_t | __hash__ () const |
| virtual std::string | get_type_name () const =0 |
| Return a string identifying the type of the object. | |
| 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. | |
| 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 ModelObjectsTemp | do_get_inputs () const =0 |
| virtual ModelObjectsTemp | do_get_outputs () const =0 |
| virtual void | do_update_dependencies (const DependencyGraph &, const DependencyGraphVertexIndex &) |
| void | update_dependencies (const DependencyGraph &dg, const DependencyGraphVertexIndex &index) |
| Protected Member Functions inherited from IMP::base::Object | |
| Object (std::string name) | |
| Optimizer* IMP::core::Mover::get_optimizer | ( | ) | const |
Get a pointer to the optimizer which has this mover.
|
pure virtual |
Return the set of particles over which moves can be proposed.
Implemented in IMP::core::MoverBase.
|
pure virtual |
propose a modification
| [in] | size | A number between 0 and 1 used to scale the proposed moves. This number can be either used to scale a continuous move or affect the probability of a discrete move. |
The method should return the list of all particles that were actually moved.
Implemented in IMP::core::MoverBase.
|
pure virtual |
Roll back any changes made to the Particles.
Implemented in IMP::core::MoverBase.
