Clipper
Public Member Functions | List of all members
clipper::Coord_reci_orth Class Reference

orthogonal reciprocal coordinate (length of which is invresolsq) More...

#include <coords.h>

Inheritance diagram for clipper::Coord_reci_orth:
clipper::Vec3<>

Public Member Functions

 Coord_reci_orth ()
 null constructor
 
 Coord_reci_orth (const Vec3<> &v)
 constructor: copy/convert
 
 Coord_reci_orth (const ftype &xs, const ftype &ys, const ftype &zs)
 constructor: from x*,y*,z*
 
const ftypexs () const
 get x*
 
const ftypeys () const
 get y*
 
const ftypezs () const
 get z*
 
ftype invresolsq () const
 return inverse resolution squared for this coord More...
 
Coord_reci_frac coord_reci_frac (const Cell &cell) const
 orthogonal-fractional reciprocal space coordinate conversion More...
 
Coord_reci_orth transform (const RTop_orth &op) const
 return transformed coordinate
 
String format () const
 return formatted String representation More...
 
- Public Member Functions inherited from clipper::Vec3<>
 Vec3 ()
 null constructor
 
 Vec3 (const ftype &v0, const ftype &v1, const ftype &v2)
 constructor: from individual values
 
 Vec3 (const Vec3< TT > &v)
 constructor: copy/convert
 
bool equals (const Vec3< ftype > &v, const ftype &tol) const
 test equality
 
const ftypeoperator[] (const int &i) const
 get element
 
ftypeoperator[] (const int &i)
 set element
 
Vec3< ftypeunit () const
 return unit vector with same direction as this vector
 
bool is_null () const
 test for null vector
 
String format () const
 return formatted String representation
 
const Vec3< ftype > & operator+= (const Vec3< ftype > &v)
 add another vector to this one
 
const Vec3< ftype > & operator-= (const Vec3< ftype > &v)
 subtract another vector from this one
 

Additional Inherited Members

- Static Public Member Functions inherited from clipper::Vec3<>
static Vec3< ftypezero ()
 return zero vector
 
static Vec3< ftypenull ()
 return null vector (only valid for floating point types)
 
static ftype dot (const Vec3< ftype > &v1, const Vec3< ftype > &v2)
 Vector dot product (equivalent to *)
 
static Vec3< ftypecross (const Vec3< ftype > &v1, const Vec3< ftype > &v2)
 Vector cross product.
 

Detailed Description

orthogonal reciprocal coordinate (length of which is invresolsq)

Member Function Documentation

◆ invresolsq()

ftype clipper::Coord_reci_orth::invresolsq ( ) const
inline

return inverse resolution squared for this coord

Returns
The inverse resolution squared.

◆ coord_reci_frac()

Coord_reci_frac clipper::Coord_reci_orth::coord_reci_frac ( const Cell cell) const
inline

orthogonal-fractional reciprocal space coordinate conversion

Parameters
cellThe cell concerned
Returns
The transformed coordinate.

◆ format()

String clipper::Coord_reci_orth::format ( ) const

return formatted String representation

Returns
The formatted text string

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