IMP  2.1.0
The Integrative Modeling Platform
IMP::isd::Weight Class Reference

Add weights for a set of states to a particle.

#include <IMP/isd/Weight.h>

+ Inheritance diagram for IMP::isd::Weight:

Public Member Functions

 Weight (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 Weight (const IMP::kernel::ParticleAdaptor &d)
 
void add_weight ()
 Add one weight.
 
Int get_number_of_states ()
 Get number of states.
 
Float get_weight (int i)
 Get the i-th weight.
 
algebra::VectorKD get_weights ()
 Get all the weights.
 
void set_weights (algebra::VectorKD w)
 Set all the weights.
 
void set_weights_are_optimized (bool tf)
 Set weights are optimized.
 
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 Weight 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 IntKey get_nstates_key ()
 Get number of states key.
 
static FloatKey get_weight_key (int i)
 Get i-th weight key.
 
static bool particle_is_instance (::IMP::kernel::Particle *p)
 
static bool particle_is_instance (IMP::kernel::Model *m, IMP::kernel::ParticleIndex pi)
 
static Weight setup_particle (IMP::kernel::ParticleAdaptor decorator)
 
static Weight setup_particle (kernel::Model *m, ParticleIndex pi)
 
- 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

Definition at line 24 of file Weight.h.

Member Function Documentation

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

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

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

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

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

Definition at line 33 of file Weight.h.


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