IMP logo
IMP Reference Guide  2.20.2
The Integrative Modeling Platform
IMP::isd::Switching Class Reference

Add switching parameter to particle. More...

#include <IMP/isd/Switching.h>

+ Inheritance diagram for IMP::isd::Switching:

Detailed Description

Add switching parameter to particle.

This is just syntactic sugar for a Nuisance bounded to be between 0 and 1.

Definition at line 23 of file Switching.h.

Public Member Functions

 Switching (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Switching (const IMP::ParticleAdaptor &d)
 
void add_to_switching_derivative (Float d, DerivativeAccumulator &accum)
 
Float get_switching () const
 
Float get_switching_derivative () const
 
bool get_switching_is_optimized () const
 
void set_switching (Float d)
 
void set_switching_is_optimized (bool val)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::isd::Nuisance
 Nuisance (::IMP::Model *m,::IMP::ParticleIndex id)
 
 Nuisance (const IMP::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 (Particle *d)
 
void set_nuisance (Float d)
 
void set_nuisance_is_optimized (bool val)
 
void set_upper (Float d)
 
void set_upper (Particle *d)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::Decorator
bool get_is_valid () const
 Returns true if constructed with a non-default constructor. More...
 
Modelget_model () const
 Returns the Model containing the particle. More...
 
Particleget_particle () const
 Returns the particle decorated by this decorator. More...
 
ParticleIndex get_particle_index () const
 Returns the particle index decorated by this decorator. More...
 
 operator Particle * () const
 
 operator ParticleIndex () const
 
Particleoperator-> () const
 

Static Public Member Functions

static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 
static FloatKey get_switching_key ()
 
static Switching setup_particle (Model *m, ParticleIndex pi)
 
static Switching setup_particle (IMP::ParticleAdaptor pa)
 
static Switching setup_particle (Model *m, ParticleIndex pi, double switching)
 
static Switching setup_particle (IMP::ParticleAdaptor pa, double switching)
 
- Static Public Member Functions inherited from IMP::isd::Nuisance
static bool get_is_setup (const IMP::ParticleAdaptor &p)
 
static bool get_is_setup (Model *m, ParticleIndex pi)
 
static FloatKey get_lower_key ()
 
static ParticleIndexKey get_lower_particle_key ()
 
static FloatKey get_nuisance_key ()
 
static FloatKey get_upper_key ()
 
static ParticleIndexKey get_upper_particle_key ()
 
static Nuisance setup_particle (Model *m, ParticleIndex pi)
 
static Nuisance setup_particle (IMP::ParticleAdaptor pa)
 
static Nuisance setup_particle (Model *m, ParticleIndex pi, double nuisance)
 
static Nuisance setup_particle (IMP::ParticleAdaptor pa, double nuisance)
 

Additional Inherited Members

- Protected Member Functions inherited from IMP::Decorator
 Decorator (Model *m, ParticleIndex pi)
 
 Decorator (ParticleAdaptor p)
 

Member Function Documentation

static Switching IMP::isd::Switching::setup_particle ( IMP::ParticleAdaptor  pa)
static
Returns
a Switching object that decorates the particle specified by pa
See Also
setup_particle(m, p)

Definition at line 34 of file Switching.h.

static Switching IMP::isd::Switching::setup_particle ( Model m,
ParticleIndex  pi 
)
static
Returns
a Switching object that decorates particle pi

Definition at line 34 of file Switching.h.

static Switching IMP::isd::Switching::setup_particle ( Model m,
ParticleIndex  pi,
double  switching 
)
static
Returns
a Switching object that decorates particle pi

Definition at line 35 of file Switching.h.

static Switching IMP::isd::Switching::setup_particle ( IMP::ParticleAdaptor  pa,
double  switching 
)
static
Returns
a Switching object that decorates the particle specified by pa
See Also
setup_particle(m, pi, switching )

Definition at line 35 of file Switching.h.


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