IMP logo
IMP Reference Guide  2.8.0
The Integrative Modeling Platform
IMP::isd::Weight Class Reference

Add weights for a set of states to a particle. More...

#include <IMP/isd/Weight.h>

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

Detailed Description

Add weights for a set of states to a particle.

Definition at line 24 of file Weight.h.

Public Member Functions

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

Additional Inherited Members

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

Member Function Documentation

void IMP::isd::Weight::add_weight ( )

Add one weight.

static IntKey IMP::isd::Weight::get_nstates_key ( )
static

Get number of states key.

Int IMP::isd::Weight::get_number_of_states ( )

Get number of states.

Float IMP::isd::Weight::get_weight ( int  i)

Get the i-th weight.

static FloatKey IMP::isd::Weight::get_weight_key ( int  i)
static

Get i-th weight key.

algebra::VectorKD IMP::isd::Weight::get_weights ( )

Get all the weights.

void IMP::isd::Weight::set_weights ( algebra::VectorKD  w)

Set all the weights.

void IMP::isd::Weight::set_weights_are_optimized ( bool  tf)

Set weights are optimized.

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

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

Definition at line 31 of file Weight.h.


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