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

map coordinate: this is like Coord_grid, but non-integer More...

#include <coords.h>

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

Public Member Functions

 Coord_map ()
 null constructor
 
 Coord_map (const Vec3<> &v)
 constructor: copy/convert
 
 Coord_map (const Coord_grid &c)
 constructor: from Coord_grid
 
 Coord_map (const ftype &u, const ftype &v, const ftype &w)
 constructor: from u,v,w
 
Coord_frac coord_frac (const Grid &g) const
 grid-fractional coordinate conversion More...
 
Coord_grid coord_grid () const
 return integer Coord_grid nearest this coordinate
 
Coord_grid floor () const
 return integer Coord_grid below this coordinate
 
Coord_grid ceil () const
 return integer Coord_grid above this coordinate
 
const ftypeu () const
 get u
 
const ftypev () const
 get v
 
const ftypew () const
 get w
 
String format () const
 return formatted String representation More...
 
- Public Member Functions inherited from clipper::Vec3<>
 Vec3 ()
 null constructor
 
 Vec3 (const T &v0, const T &v1, const T &v2)
 constructor: from individual values
 
 Vec3 (const Vec3< TT > &v)
 constructor: copy/convert
 
bool equals (const Vec3< T > &v, const T &tol) const
 test equality
 
const T & operator[] (const int &i) const
 get element
 
T & operator[] (const int &i)
 set element
 
Vec3< T > unit () 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< T > & operator+= (const Vec3< T > &v)
 add another vector to this one
 
const Vec3< T > & operator-= (const Vec3< T > &v)
 subtract another vector from this one
 

Friends

Coord_map operator- (const Coord_map &u1)
 
Coord_map operator+ (const Coord_map &u1, const Coord_map &u2)
 
Coord_map operator- (const Coord_map &u1, const Coord_map &u2)
 
Coord_map operator* (const ftype &s, const Coord_map &u1)
 

Additional Inherited Members

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

Detailed Description

map coordinate: this is like Coord_grid, but non-integer

Member Function Documentation

Coord_frac clipper::Coord_map::coord_frac ( const Grid g) const
inline

grid-fractional coordinate conversion

Parameters
gThe grid concerned
Returns
The transformed coordinate.
String clipper::Coord_map::format ( ) const

return formatted String representation

Returns
The formatted text string

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