IMP  2.1.0
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:

Public Member Functions

 Switching (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 Switching (const IMP::kernel::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::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
 
Particleget_particle () const
 
Modelget_model () const
 Returns the Model containing the particle.
 
 Decorator (Particle *p)
 
 Decorator ()
 

Static Public Member Functions

static Switching 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_switching_key ()
 
static bool particle_is_instance (::IMP::kernel::Particle *p)
 
static bool particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
 
static Switching setup_particle (kernel::Model *m, ParticleIndex pi)
 
static Switching setup_particle (IMP::kernel::ParticleAdaptor decorator)
 
static Switching setup_particle (IMP::kernel::ParticleAdaptor decorator, double switching)
 
static Switching setup_particle (kernel::Model *m, ParticleIndex pi, double switching)
 
- 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 betweeen 0 and 1.

Definition at line 23 of file Switching.h.

Member Function Documentation

static Switching IMP::isd::Switching::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 34 of file Switching.h.

static bool IMP::isd::Switching::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 34 of file Switching.h.

static bool IMP::isd::Switching::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 34 of file Switching.h.

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

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

Definition at line 35 of file Switching.h.

static Switching IMP::isd::Switching::setup_particle ( kernel::Model m,
ParticleIndex  pi,
double  switching 
)
static

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

Definition at line 36 of file Switching.h.


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