IMP::isd::Scale Class Reference

---

Detailed Description

Add scale parameter to particle.

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

Inheritance diagram for IMP::isd::Scale:

List of all members.

Public Member Functions
	Scale (Model *m, ParticleIndex id)
	Scale (::IMP::Particle *p)
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 (Model *m, ParticleIndex id)
	Nuisance (::IMP::Particle *p)
void	add_to_nuisance_derivative (Float d, DerivativeAccumulator &accum)
Float	get_lower () const
Float	get_nuisance () const
Float	get_nuisance_derivative () const
bool	get_nuisance_is_optimized () const
Float	get_upper () const
bool	has_lower () const
bool	has_upper () const
void	set_lower (Float d)
void	set_lower (Particle *d)
void	set_nuisance (Float d)
void	set_nuisance_is_optimized (bool val)
void	set_upper (Float d)
void	set_upper (Particle *d)
Public Member Functions inherited from IMP::Decorator
std::size_t	__hash__ () const
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::Particle *p)
static FloatKey	get_scale_key ()
static bool	particle_is_instance (Particle *p)
	Return true if the particle can be cast to the decorator.
static Scale	setup_particle (Particle *p, double scale=1.0)
Static Public Member Functions inherited from IMP::isd::Nuisance
static FloatKey	get_lower_key ()
static ParticleKey	get_lower_particle_key ()
static FloatKey	get_nuisance_key ()
static FloatKey	get_upper_key ()
static ParticleKey	get_upper_particle_key ()
static Decorator	setup_particle (Particle *p, extra_arguments)

---

Member Function Documentation

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

static

Return true if the particle can be cast to the decorator.

That is, if particle_is_instance() returns true, then it is legal to construct an instance of the decorator with that particle. If not, setup_particle() must be called first.

  IMP::Particle *p = new IMP::Particle(m);
  // it is false
  std::cout << IMP::core::XYZ::particle_is_instance(p) << std::endl;
  // As a result this is an error
  IMP::core::XYZ d(p);
  // now set it up
  IMP::core::XYZ(p);
  // now it is true
  std::cout << IMP::core::XYZ::particle_is_instance(p) << std::endl;
  // and now this code is OK
  IMP::core::XYZ d(p);

Reimplemented from IMP::isd::Nuisance.

---

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

• Scale.h
• isd/__init__.py