A class to help implement movers. More...

#include <IMP/core/MoverBase.h>

Inheritance diagram for IMP::core::MoverBase:

Public Member Functions
ParticlesTemp	get_output_particles () const
	Return the set of particles over which moves can be proposed.

virtual ParticlesTemp	propose_move (Float f)

virtual void	reset_move ()
	Roll back any changes made to the Particles.

Public Member Functions inherited from IMP::core::Mover
	Mover (Model *m, std::string name)

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

Model *	get_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
	MoverBase (const ParticlesTemp &ps, const FloatKeys &keys, std::string name)

virtual void	do_move (Float f)=0
	implement this method to propose a move More...

unsigned int	get_number_of_keys () const

unsigned int	get_number_of_particles () const

std::string	get_particle_name (unsigned int i) const

Float	get_value (unsigned int i, unsigned int j) const
	Get the value of a controlled attribute. More...

void	propose_value (unsigned int i, unsigned int j, Float t)
	Propose a value. More...

Protected Member Functions inherited from IMP::core::Mover
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...

Related Functions
(Note that these are not member functions.)
typedef IMP::base::Vector < IMP::base::WeakPointer < MoverBase > >	MoverBasesTemp

Detailed Description

This class helps in implementing Movers by allowing changes to be easily rolled back. It maintains a list of particles and a list of attributes. All changes to the product of those two lists will be rolled back when reject_move() is called.

See NormalMover for a simple example using this class.

Definition at line 32 of file MoverBase.h.

Member Function Documentation

virtual void IMP::core::MoverBase::do_move ( Float f )

protectedpure virtual

See NormalMover for a simple example.

Float IMP::core::MoverBase::get_value	(	unsigned int	i,
		unsigned int	j
	)		const

protected

Parameters

[in]	i	The index of the particle.
[in]	j	The index of the attribute.

Definition at line 89 of file MoverBase.h.

ParticlesTemp IMP::core::MoverBase::propose_move ( Float f )

virtual

This sets everything up and then calls the generate_move method.

Implements IMP::core::Mover.

Definition at line 113 of file MoverBase.h.

void IMP::core::MoverBase::propose_value	(	unsigned int	i,
		unsigned int	j,
		Float	t
	)

protected

Parameters

[in]	i	The index of the particle.
[in]	j	The index of the key
[in]	t	The value to propose

Definition at line 100 of file MoverBase.h.

Friends And Related Function Documentation

typedef IMP::base::Vector<IMP::base::WeakPointer< MoverBase > > MoverBasesTemp

Definition at line 136 of file MoverBase.h.

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

MoverBase.h

Public Member Functions

Protected Member Functions

Related Functions

Detailed Description

Member Function Documentation

Friends And Related Function Documentation