IMP::isd::Scale Class Reference

Add scale parameter to particle. More...

#include <IMP/isd/Scale.h>

Inheritance diagram for IMP::isd::Scale:

Public Member Functions
	Scale (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
	Scale (const IMP::kernel::ParticleAdaptor &d)
void	add_to_scale_derivative (Float d, DerivativeAccumulator &accum)
Float	get_scale () const
Float	get_scale_derivative () const
bool	get_scale_is_optimized () const
void	set_scale (Float d)
void	set_scale_is_optimized (bool val)
void	show (std::ostream &out=std::cout) const
Public Member Functions inherited from IMP::isd::Nuisance
	Nuisance (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
	Nuisance (const IMP::kernel::ParticleAdaptor &d)
void	add_to_nuisance_derivative (Float d, DerivativeAccumulator &accum)
bool	get_has_lower () const
bool	get_has_upper () const
Float	get_lower () const
Float	get_nuisance () const
Float	get_nuisance_derivative () const
bool	get_nuisance_is_optimized () const
Float	get_upper () const
void	remove_lower ()
void	remove_upper ()
void	set_lower (Float d)
void	set_lower (kernel::Particle *d)
void	set_nuisance (Float d)
void	set_nuisance_is_optimized (bool val)
void	set_upper (Float d)
void	set_upper (kernel::Particle *d)
void	show (std::ostream &out=std::cout) const
Public Member Functions inherited from IMP::kernel::Decorator
ParticleIndex	get_particle_index () const
Particle *	get_particle () const
Model *	get_model () const
	Returns the Model containing the particle.
	Decorator (Particle *p)
	Decorator ()

Static Public Member Functions
static Scale	decorate_particle (::IMP::kernel::Particle *p)
static bool	get_is_setup (const IMP::kernel::ParticleAdaptor &p)
static bool	get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
static FloatKey	get_scale_key ()
static bool	particle_is_instance (::IMP::kernel::Particle *p)
static bool	particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
static Scale	setup_particle (kernel::Model *m, ParticleIndex pi)
static Scale	setup_particle (IMP::kernel::ParticleAdaptor decorator)
static Scale	setup_particle (IMP::kernel::ParticleAdaptor decorator, double scale)
static Scale	setup_particle (kernel::Model *m, ParticleIndex pi, double scale)
Static Public Member Functions inherited from IMP::isd::Nuisance
static Nuisance	decorate_particle (::IMP::kernel::Particle *p)
static bool	get_is_setup (const IMP::kernel::ParticleAdaptor &p)
static bool	get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
static FloatKey	get_lower_key ()
static kernel::ParticleIndexKey	get_lower_particle_key ()
static FloatKey	get_nuisance_key ()
static FloatKey	get_upper_key ()
static kernel::ParticleIndexKey	get_upper_particle_key ()
static bool	particle_is_instance (::IMP::kernel::Particle *p)
static bool	particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
static Nuisance	setup_particle (kernel::Model *m, ParticleIndex pi)
static Nuisance	setup_particle (IMP::kernel::ParticleAdaptor decorator)
static Nuisance	setup_particle (IMP::kernel::ParticleAdaptor decorator, double nuisance)
static Nuisance	setup_particle (kernel::Model *m, ParticleIndex pi, double nuisance)
Static Public Member Functions inherited from IMP::kernel::Decorator
static bool	get_is_setup (Particle *p)
	Return true if the particle can be cast to the decorator. More...

Additional Inherited Members
Protected Member Functions inherited from IMP::kernel::Decorator
	Decorator (kernel::Model *m, ParticleIndex pi)
	Decorator (ParticleAdaptor p)

Detailed Description

This is just syntactic sugar for a Nuisance bounded to be positive.

Definition at line 24 of file Scale.h.

Member Function Documentation

static Scale IMP::isd::Scale::decorate_particle ( ::IMP::kernel::Particle *  p )

static

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Check explicitly instead.

Definition at line 29 of file Scale.h.

static bool IMP::isd::Scale::particle_is_instance ( ::IMP::kernel::Particle *  p )

static

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 29 of file Scale.h.

static bool IMP::isd::Scale::particle_is_instance ( IMP::kernel::Model *  m, IMP::kernel::ParticleIndex  pi  )

static

Deprecated:

As of IMP release 2.1. See the IMP Deprecation Policy for more information about deprecation in IMP. Use get_is_setup() instead.

Definition at line 29 of file Scale.h.

static Scale IMP::isd::Scale::setup_particle ( kernel::Model *  m, ParticleIndex  pi  )

static

Setup the particle so it can be used with this decorator.

Definition at line 30 of file Scale.h.

static Scale IMP::isd::Scale::setup_particle ( kernel::Model *  m, ParticleIndex  pi, double  scale  )

static

Setup the particle so it can be used with this decorator.

Definition at line 31 of file Scale.h.

---

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

• Scale.h