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:

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 ftype &	xs () const
	get x*
const ftype &	ys () const
	get y*
const ftype &	zs () const
ftype	invresolsq () const
	return inverse resolution squared for this coord
Coord_reci_frac	coord_reci_frac (const Cell &cell) const
	orthogonal-fractional reciprocal space coordinate conversion
Coord_reci_orth	transform (const RTop_orth &op) const
	return transformed coordinate
String	format () const
	return formatted String representation
Public Member Functions inherited from clipper::Vec3< T >
	Vec3 ()
	null constructor
	Vec3 (const T &v0, const T &v1, const T &v2)
	constructor: from individual values
template<class TT>
	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

Additional Inherited Members
Static Public Member Functions inherited from clipper::Vec3< T >
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

orthogonal reciprocal coordinate (length of which is invresolsq)

Member Function Documentation

zs()

const ftype & clipper::Coord_reci_orth::zs ( ) const

inline

get z*

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

cell	The 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:

• coords.h
• coords.cpp