 |
Add switching parameter to particle.
This is just syntactic sugar for a Nuisance bounded to be betweeen 0 and 1.
Inheritance diagram for IMP::isd::Switching:Public Member Functions | |
| Switching (Model *m, ParticleIndex id) | |
| Switching (::IMP::Particle *p) | |
| 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 (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 Switching | decorate_particle (::IMP::Particle *p) |
| static FloatKey | get_switching_key () |
| static bool | particle_is_instance (Particle *p) |
| Return true if the particle can be cast to the decorator. | |
| static Switching | setup_particle (Particle *p, double switching=0.5) |
| 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) |
|
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.
Reimplemented from IMP::isd::Nuisance.
