IMP logo

IMP::core::Mover Class Reference


Detailed Description

A base class for classes which pertub 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.

See also:
MonteCarlo
Inheritance diagram for IMP::core::Mover:

Inheritance graph
[legend]

Public Member Functions

virtual void accept_move ()=0
 set whether the proposed modification is accepted
Optimizerget_optimizer () const
 Get a pointer to the optimizer which has this mover.
 Mover (std::string name=std::string("Mover"))
virtual void propose_move (Float size)=0
 propose a modification
virtual void reject_move ()=0
 Roll back any changes made to the Particles.
virtual void show (std::ostream &out=std::cout) const

Friends

template<class T >
void IMP::internal::unref (T *)

Member Function Documentation

virtual void IMP::core::Mover::accept_move (  )  [pure virtual]

set whether the proposed modification is accepted

Note:
Accepting should not change the Particles at all.

virtual void IMP::core::Mover::propose_move ( Float  size  )  [pure virtual]

propose a modification

Parameters:
[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.

Implemented in IMP::core::MoverBase.


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

Generated on Mon Mar 8 23:08:57 2010 for IMP by doxygen 1.5.8