IMP logo
Public Member Functions | Static Public Member Functions
IMP::core::BallMover Class Reference

Detailed Description

Modify a set of continuous variables by perturbing them within a ball.

The variables are perturbed within a ball of the given radius.

See also:
MonteCarlo

Examples: display log, optimize balls, incremental mc

+ Inheritance diagram for IMP::core::BallMover:

List of all members.

Public Member Functions

 BallMover (const ParticlesTemp &sc, const FloatKeys &vars, Float radius)
 BallMover (const ParticlesTemp &sc, Float radius)
Float get_radius () const
void set_radius (Float radius)
- Public Member Functions inherited from IMP::core::MoverBase
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)
Optimizerget_optimizer () const
 Get a pointer to the optimizer which has this mover.
- Public Member Functions inherited from IMP::ModelObject
 ModelObject (Model *m, std::string name)
ModelObjectsTemp get_inputs () const
Modelget_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)

Static Public Member Functions

static BallMoverget_from (IMP::base::Object *o)

Additional Inherited Members

- Protected Member Functions inherited from IMP::core::MoverBase
 MoverBase (const ParticlesTemp &ps, const FloatKeys &keys, std::string name)
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.
void propose_value (unsigned int i, unsigned int j, Float t)
 Propose a value.

Constructor & Destructor Documentation

IMP::core::BallMover::BallMover ( const ParticlesTemp sc,
const FloatKeys &  vars,
Float  radius 
)

The attributes are perturbed within a ball whose dimensionality is given by the number of attributes and radius by the given value.

Parameters:
[in]scThe set of particles to perturb.
[in]varsThe variables to use (normally the keys for x,y,z)
[in]radiusThe radius deviation to use.
IMP::core::BallMover::BallMover ( const ParticlesTemp sc,
Float  radius 
)

The x,y,z coordinates are perturbed within a ball.

Parameters:
[in]scThe set of particles to perturb.
[in]radiusThe radius deviation to use.

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

Generated on Tue May 22 2012 23:33:30 for IMP by doxygen 1.8.1