A decorator for a particle with x,y,z coordinates.
More...
#include <IMP/core/XYZ.h>
A decorator for a particle with x,y,z coordinates.
Using the decorator one can get and set coordinates and modify derivatives.
13 p0 = m.add_particle(
"xyz0")
16 p1 = m.add_particle(
"xyz1")
- See Also
- XYZR
- Examples:
- core/simple.cpp.
Definition at line 30 of file XYZ.h.
Add v to the derivative of the ith coordinate, used by various
Definition at line 78 of file XYZ.h.
Add the vector v to the derivative vector of the x,y,z coordinates.
Definition at line 82 of file XYZ.h.
Float IMP::core::XYZ::get_coordinate |
( |
int |
i | ) |
const |
Get the ith coordinate.
Definition at line 69 of file XYZ.h.
Convert it to a vector.
Somewhat suspect based on wanting a Point/Vector differentiation but we don't have points
Definition at line 109 of file XYZ.h.
bool IMP::core::XYZ::get_coordinates_are_optimized |
( |
| ) |
const |
Get whether the coordinates are optimized.
- Returns
- true only if all of them are optimized.
Definition at line 89 of file XYZ.h.
Float IMP::core::XYZ::get_derivative |
( |
int |
i | ) |
const |
Get the vector of derivatives accumulated by add_to_derivatives().
Somewhat suspect based on wanting a Point/Vector differentiation but we don't have points
Definition at line 116 of file XYZ.h.
Get the vector from this particle to another.
Definition at line 102 of file XYZ.h.
Float IMP::core::XYZ::get_x |
( |
| ) |
const |
returns the value of the x attribute
Definition at line 54 of file XYZ.h.
static const FloatKeys& IMP::core::XYZ::get_xyz_keys |
( |
| ) |
|
|
static |
Get a vector containing the keys for x,y,z.
This is quite handy for initializing movers and things.
Float IMP::core::XYZ::get_y |
( |
| ) |
const |
returns the value of the y attribute
Definition at line 55 of file XYZ.h.
Float IMP::core::XYZ::get_z |
( |
| ) |
const |
returns the value of the z attribute
Definition at line 56 of file XYZ.h.
void IMP::core::XYZ::set_coordinate |
( |
unsigned int |
i, |
|
|
Float |
v |
|
) |
| |
set the ith coordinate
Definition at line 58 of file XYZ.h.
void IMP::core::XYZ::set_coordinates_are_optimized |
( |
bool |
tf | ) |
const |
Set whether the coordinates are optimized.
Definition at line 95 of file XYZ.h.
void IMP::core::XYZ::set_x |
( |
Float |
t | ) |
|
sets the value of the x attribute to t
Definition at line 54 of file XYZ.h.
void IMP::core::XYZ::set_y |
( |
Float |
t | ) |
|
sets the value of the y attribute to t
Definition at line 55 of file XYZ.h.
void IMP::core::XYZ::set_z |
( |
Float |
t | ) |
|
sets the value of the z attribute to t
Definition at line 56 of file XYZ.h.
- Returns
- a XYZ object that decorates the particle specified by pa
- See Also
- setup_particle(m, p)
Definition at line 51 of file XYZ.h.
- Returns
- a XYZ object that decorates particle pi
Definition at line 52 of file XYZ.h.
- Returns
- a XYZ object that decorates the particle specified by pa
- See Also
- setup_particle(m, pi, v )
Definition at line 52 of file XYZ.h.
The documentation for this class was generated from the following file: