IMP  2.2.1
The Integrative Modeling Platform
IMP::core::Cover Class Reference

A particle which covers a set of other particles. More...

#include <IMP/core/CoverRefined.h>

+ Inheritance diagram for IMP::core::Cover:

Public Member Functions

 Cover (const IMP::kernel::ParticleAdaptor &d)
 
 Cover (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
Constraintget_constraint () const
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::core::XYZR
 XYZR (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 XYZR (const IMP::kernel::ParticleAdaptor &d)
 
void add_to_radius_derivative (double v, DerivativeAccumulator &d)
 
double get_radius () const
 
const algebra::Sphere3Dget_sphere () const
 Return a sphere object.
 
void set_radius (double r) const
 
void set_sphere (const algebra::Sphere3D &s)
 Set the attributes from a sphere.
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::core::XYZ
 XYZ (::IMP::kernel::Model *m,::IMP::kernel::ParticleIndex id)
 
 XYZ (const IMP::kernel::ParticleAdaptor &d)
 
void add_to_derivative (int i, Float v, DerivativeAccumulator &d)
 Add something to the derivative of the ith coordinate.
 
void add_to_derivatives (const algebra::Vector3D &v, DerivativeAccumulator &d)
 Add something to the derivative of the coordinates.
 
Float get_coordinate (int i) const
 Get the ith coordinate.
 
const algebra::Vector3Dget_coordinates () const
 Convert it to a vector. More...
 
bool get_coordinates_are_optimized () const
 Get whether the coordinates are optimized. More...
 
Float get_derivative (int i) const
 Get the ith coordinate derivative.
 
algebra::Vector3D get_derivatives () const
 Get the vector of derivatives. More...
 
algebra::Vector3D get_vector_to (const XYZ &b) const
 Get the vector from this particle to another.
 
Float get_x () const
 
Float get_y () const
 
Float get_z () const
 
void set_coordinate (unsigned int i, Float v)
 set the ith coordinate
 
void set_coordinates (const algebra::Vector3D &v)
 set all coordinates from a vector
 
void set_coordinates_are_optimized (bool tf) const
 Set whether the coordinates are optimized.
 
void set_x (Float t)
 
void set_y (Float t)
 
void set_z (Float t)
 
void show (std::ostream &out=std::cout) const
 
- Public Member Functions inherited from IMP::kernel::Decorator
Modelget_model () const
 Returns the Model containing the particle.
 
Particleget_particle () const
 
ParticleIndex get_particle_index () const
 
 operator Particle * () const
 
 operator ParticleIndex () const
 
Particleoperator-> () const
 

Static Public Member Functions

static Cover decorate_particle (::IMP::kernel::Particle *p)
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, ParticleIndex pi)
 
static Cover setup_particle (kernel::Model *m, ParticleIndex pi, Refiner *refiner)
 
static Cover setup_particle (IMP::kernel::ParticleAdaptor decorator, ParticleIndexesAdaptor members)
 
static Cover setup_particle (IMP::kernel::ParticleAdaptor decorator, Refiner *refiner)
 
static Cover setup_particle (kernel::Model *m, ParticleIndex pi, ParticleIndexesAdaptor members)
 
- Static Public Member Functions inherited from IMP::core::XYZR
static XYZR 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)
 Check if the particle has the required attributes. More...
 
static FloatKey get_radius_key ()
 
static XYZR setup_particle (IMP::kernel::ParticleAdaptor decorator)
 
static XYZR setup_particle (kernel::Model *m, ParticleIndex pi)
 
static XYZR setup_particle (kernel::Model *m, ParticleIndex pi, Float radius)
 
static XYZR setup_particle (IMP::kernel::ParticleAdaptor decorator, Float radius)
 
static XYZR setup_particle (IMP::kernel::ParticleAdaptor decorator, algebra::Sphere3D ball)
 
static XYZR setup_particle (kernel::Model *m, ParticleIndex pi, algebra::Sphere3D ball)
 
- Static Public Member Functions inherited from IMP::core::XYZ
static XYZ decorate_particle (::IMP::kernel::Particle *p)
 
static FloatKey get_coordinate_key (unsigned int i)
 
static bool get_is_setup (const IMP::kernel::ParticleAdaptor &p)
 
static bool get_is_setup (kernel::Model *m, kernel::ParticleIndex pi)
 
static const FloatKeysget_xyz_keys ()
 Get a vector containing the keys for x,y,z. More...
 
static XYZ setup_particle (IMP::kernel::ParticleAdaptor decorator)
 
static XYZ setup_particle (kernel::Model *m, ParticleIndex pi)
 
static XYZ setup_particle (IMP::kernel::ParticleAdaptor decorator, algebra::Vector3D v)
 
static XYZ setup_particle (kernel::Model *m, ParticleIndex pi, algebra::Vector3D v)
 

Additional Inherited Members

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

Detailed Description

A decorator which sets up a particle to be a cover of a set of other particles. That is, the sphere defined by its XYZR decorator will always contain the passed particles.

Note
The maintenance of the invariant is done by an associated IMP::Constraint. As a result, the state is only guaranteed to be correct either during model evaluation, or immediately following model evaluation before any particles have been changed.

Definition at line 72 of file CoverRefined.h.

Member Function Documentation

static Cover IMP::core::Cover::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 72 of file CoverRefined.h.

static Cover IMP::core::Cover::setup_particle ( IMP::kernel::ParticleAdaptor  decorator,
ParticleIndexesAdaptor  members 
)
static
See Also
setup_particle(m, pi, members )

Definition at line 72 of file CoverRefined.h.

static Cover IMP::core::Cover::setup_particle ( kernel::Model m,
ParticleIndex  pi,
ParticleIndexesAdaptor  members 
)
static

Sets up Cover over members, and constrains Cover to be \ computed before model evaluation and to propogate derivatives \ folllowing model evaulation. \ \ Setup the particle so that it can be used with this decorator

Definition at line 72 of file CoverRefined.h.

static Cover IMP::core::Cover::setup_particle ( IMP::kernel::ParticleAdaptor  decorator,
Refiner refiner 
)
static
See Also
setup_particle(m, pi, refiner )

Definition at line 72 of file CoverRefined.h.

static Cover IMP::core::Cover::setup_particle ( kernel::Model m,
ParticleIndex  pi,
Refiner refiner 
)
static

Sets up Cover over particles passed by applying the refiner \ over the particle pi, and constrains Cover to be computed before \ model evaluation and to propogate derivatives following model \ evaluation. \ \ Setup the particle so that it can be used with this decorator

Definition at line 72 of file CoverRefined.h.


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