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

generic grid More...

#include <coords.h>

Inheritance diagram for clipper::Grid:
clipper::Vec3< int > clipper::Grid_range clipper::Grid_sampling clipper::CGrid_sampling

Public Member Functions

 Grid ()
 null constructor
 
 Grid (const int &nu, const int &nv, const int &nw)
 constructor: from nu,nv,nw
 
const int & nu () const
 get nu
 
const int & nv () const
 get nv
 
const int & nw () const
 get nw
 
int size () const
 return size of grid array
 
bool in_grid (Coord_grid g) const
 determine if a point is in the grid
 
int index (const Coord_grid &c) const
 grid indexing operator
 
Coord_grid deindex (const int &index) const
 grid deindexing operator
 
String format () const
 return formatted String representation More...
 
void debug () const
 
- Public Member Functions inherited from clipper::Vec3< int >
 Vec3 ()
 null constructor
 
 Vec3 (const int &v0, const int &v1, const int &v2)
 constructor: from individual values
 
 Vec3 (const Vec3< TT > &v)
 constructor: copy/convert
 
bool equals (const Vec3< int > &v, const int &tol) const
 test equality
 
const int & operator[] (const int &i) const
 get element
 
int & operator[] (const int &i)
 set element
 
Vec3< int > 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< int > & operator+= (const Vec3< int > &v)
 add another vector to this one
 
const Vec3< int > & operator-= (const Vec3< int > &v)
 subtract another vector from this one
 

Additional Inherited Members

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

Detailed Description

generic grid

This holds the dimensions of a 3D array, indexed from 0 along each dimension.

Member Function Documentation

String clipper::Grid::format ( ) const

return formatted String representation

Returns
The formatted text string

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