Generated on Tue Dec 16 12:50:09 2008 for BIU-2.2.0 by doxygen 1.5.1

biu::Point3D< T > Class Template Reference

#include <Point.hh>

Inheritance diagram for biu::Point3D< T >:

Inheritance graph
[legend]

Detailed Description

template<class T>
class biu::Point3D< T >

The template Point3D represents a point in 3-dimensional space for different base types.

Author:
Martin Mann, Sebastian Will, Andreas Richter

Definition at line 41 of file Point.hh.

Public Member Functions

double distance (const Point3D &p2) const
getX () const
getY () const
getZ () const
bool isEven () const
Point3Doperator *= (const T &d)
 operator Point3D () const
 operator std::vector () const
bool operator!= (const Point3D &p2) const
Point3D operator+ (const Point3D &p2) const
Point3Doperator+= (const T &d)
Point3Doperator+= (const Point3D &p2)
Point3Doperator- ()
Point3D operator- (const Point3D &p2) const
Point3Doperator-= (const T &d)
Point3Doperator-= (const Point3D &p2)
Point3Doperator/= (const T &d)
bool operator< (const Point3D &p2) const
Point3Doperator= (const Point3D &p2)
bool operator== (const Point3D &p2) const
bool operator> (const Point3D &p2) const
 Point3D (const std::vector< T > &v)
 Point3D (const Point3D &p2)
 Point3D (const T _x, const T _y, const T _z)
 Point3D ()
void setX (const T &x_)
void setY (const T &y_)
void setZ (const T &z_)
double vectorLength () const
 ~Point3D ()

Private Member Functions

template<int >
bool equal (const int &a, const int &b) const
bool equal (const T &a, const T &b) const

Private Attributes

x
y
z

Friends

std::ostream & operator<< (std::ostream &out, const Point3D &p)


Constructor & Destructor Documentation

template<class T>
biu::Point3D< T >::Point3D (  )  [inline]

Constructs a point placed in the lattice center (0,0,0).

Definition at line 60 of file Point.hh.

template<class T>
biu::Point3D< T >::Point3D ( const T  _x,
const T  _y,
const T  _z 
) [inline]

Definition at line 63 of file Point.hh.

template<class T>
biu::Point3D< T >::Point3D ( const Point3D< T > &  p2  )  [inline]

Definition at line 66 of file Point.hh.

template<class T>
biu::Point3D< T >::Point3D ( const std::vector< T > &  v  )  [inline]

Definition at line 69 of file Point.hh.

template<class T>
biu::Point3D< T >::~Point3D (  )  [inline]

Definition at line 73 of file Point.hh.


Member Function Documentation

template<class T>
double biu::Point3D< T >::distance ( const Point3D< T > &  p2  )  const [inline]

Calculates the euclidian distance of two Point3D objects

Definition at line 160 of file Point.hh.

template<class T>
template<int >
bool biu::Point3D< T >::equal ( const int &  a,
const int &  b 
) const [inline, private]

Definition at line 54 of file Point.hh.

template<class T>
bool biu::Point3D< T >::equal ( const T &  a,
const T &  b 
) const [inline, private]

Definition at line 48 of file Point.hh.

template<class T>
T biu::Point3D< T >::getX (  )  const [inline]

Definition at line 180 of file Point.hh.

template<class T>
T biu::Point3D< T >::getY (  )  const [inline]

Definition at line 181 of file Point.hh.

template<class T>
T biu::Point3D< T >::getZ (  )  const [inline]

Definition at line 182 of file Point.hh.

template<class T>
bool biu::Point3D< T >::isEven (  )  const [inline]

Returns if the sum of x-, y- and z-component is even or not.

Definition at line 169 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator *= ( const T &  d  )  [inline]

Definition at line 103 of file Point.hh.

template<class T>
biu::Point3D< T >::operator Point3D (  )  const [inline]

Definition at line 141 of file Point.hh.

template<class T>
biu::Point3D< T >::operator std::vector (  )  const [inline]

Definition at line 76 of file Point.hh.

template<class T>
bool biu::Point3D< T >::operator!= ( const Point3D< T > &  p2  )  const [inline]

Definition at line 137 of file Point.hh.

template<class T>
Point3D biu::Point3D< T >::operator+ ( const Point3D< T > &  p2  )  const [inline]

Definition at line 113 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator+= ( const T &  d  )  [inline]

Definition at line 88 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator+= ( const Point3D< T > &  p2  )  [inline]

Definition at line 83 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator- (  )  [inline]

Definition at line 121 of file Point.hh.

template<class T>
Point3D biu::Point3D< T >::operator- ( const Point3D< T > &  p2  )  const [inline]

Definition at line 117 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator-= ( const T &  d  )  [inline]

Definition at line 98 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator-= ( const Point3D< T > &  p2  )  [inline]

Definition at line 93 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator/= ( const T &  d  )  [inline]

Definition at line 108 of file Point.hh.

template<class T>
bool biu::Point3D< T >::operator< ( const Point3D< T > &  p2  )  const [inline]

Calculates the less operator in the order: x-component, y-component, z-component

Definition at line 147 of file Point.hh.

template<class T>
Point3D& biu::Point3D< T >::operator= ( const Point3D< T > &  p2  )  [inline]

Definition at line 126 of file Point.hh.

template<class T>
bool biu::Point3D< T >::operator== ( const Point3D< T > &  p2  )  const [inline]

Definition at line 133 of file Point.hh.

template<class T>
bool biu::Point3D< T >::operator> ( const Point3D< T > &  p2  )  const [inline]

Calculates the greater operator in the order: z-component, y-component, x-component

Definition at line 154 of file Point.hh.

template<class T>
void biu::Point3D< T >::setX ( const T &  x_  )  [inline]

Definition at line 184 of file Point.hh.

template<class T>
void biu::Point3D< T >::setY ( const T &  y_  )  [inline]

Definition at line 185 of file Point.hh.

template<class T>
void biu::Point3D< T >::setZ ( const T &  z_  )  [inline]

Definition at line 186 of file Point.hh.

template<class T>
double biu::Point3D< T >::vectorLength (  )  const [inline]

Returns the length of the vector (between lattice center and this point).

Definition at line 173 of file Point.hh.


Friends And Related Function Documentation

template<class T>
std::ostream& operator<< ( std::ostream &  out,
const Point3D< T > &  p 
) [friend]

Definition at line 175 of file Point.hh.


Field Documentation

template<class T>
T biu::Point3D< T >::x [private]

the coordinates

Definition at line 45 of file Point.hh.

template<class T>
T biu::Point3D< T >::y [private]

Definition at line 45 of file Point.hh.

template<class T>
T biu::Point3D< T >::z [private]

Definition at line 45 of file Point.hh.


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