Generated on Mon Jun 23 16:25:41 2008 for BIU-1.7.0 by doxygen 1.5.1

biu::NeighborVector Class Reference

#include <NeighborVector.hh>

Inheritance diagram for biu::NeighborVector:

Inheritance graph
[legend]

Detailed Description

A NeighborVector manages lattice specific neighborhood data. It handles the vector dependend move string and the related rotation matrix to generate relative move strings.

Author:
Martin Mann, Sebastian Will, Andreas Richter

Definition at line 34 of file NeighborVector.hh.

Public Member Functions

double distance (const Point3D &p2) const
const AutomorphismgetAbs2RelRotation () const
const MovegetMove () const
const AutomorphismgetRel2AbsRotation () const
int getX () const
int getY () const
int getZ () const
bool isEven () const
 NeighborVector (const IntPoint &point)
 NeighborVector (const int x, const int y, const int z, const Move _move, const Automorphism &rel2absRot, const Automorphism &abs2relRot)
Point3Doperator *= (const int &d)
 operator Point3D () const
 operator std::vector () const
bool operator!= (const Point3D &p2) const
Point3D operator+ (const Point3D &p2) const
Point3Doperator+= (const int &d)
Point3Doperator+= (const Point3D &p2)
Point3Doperator- ()
Point3D operator- (const Point3D &p2) const
Point3Doperator-= (const int &d)
Point3Doperator-= (const Point3D &p2)
Point3Doperator/= (const int &d)
bool operator< (const Point3D &p2) const
bool operator== (const Point3D &p2) const
bool operator> (const Point3D &p2) const
void setX (const int &x_)
void setY (const int &y_)
void setZ (const int &z_)
double vectorLength () const
virtual ~NeighborVector ()

Private Attributes

Automorphism abs2relRotation
Move move
Automorphism rel2absRotation

Friends

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


Constructor & Destructor Documentation

biu::NeighborVector::NeighborVector ( const int  x,
const int  y,
const int  z,
const Move  _move,
const Automorphism rel2absRot,
const Automorphism abs2relRot 
) [inline]

Definition at line 46 of file NeighborVector.hh.

biu::NeighborVector::NeighborVector ( const IntPoint point  )  [inline]

Definition at line 54 of file NeighborVector.hh.

virtual biu::NeighborVector::~NeighborVector (  )  [inline, virtual]

Definition at line 57 of file NeighborVector.hh.


Member Function Documentation

double biu::Point3D< int >::distance ( const Point3D< int > &  p2  )  const [inline, inherited]

Calculates the euclidian distance of two Point3D objects

Definition at line 160 of file Point.hh.

const Automorphism& biu::NeighborVector::getAbs2RelRotation (  )  const [inline]

Definition at line 67 of file NeighborVector.hh.

const Move& biu::NeighborVector::getMove (  )  const [inline]

Definition at line 60 of file NeighborVector.hh.

const Automorphism& biu::NeighborVector::getRel2AbsRotation (  )  const [inline]

Definition at line 64 of file NeighborVector.hh.

int biu::Point3D< int >::getX (  )  const [inline, inherited]

Definition at line 180 of file Point.hh.

int biu::Point3D< int >::getY (  )  const [inline, inherited]

Definition at line 181 of file Point.hh.

int biu::Point3D< int >::getZ (  )  const [inline, inherited]

Definition at line 182 of file Point.hh.

bool biu::Point3D< int >::isEven (  )  const [inline, inherited]

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

Definition at line 169 of file Point.hh.

Point3D& biu::Point3D< int >::operator *= ( const int &  d  )  [inline, inherited]

Definition at line 103 of file Point.hh.

biu::Point3D< int >::operator Point3D (  )  const [inline, inherited]

Definition at line 141 of file Point.hh.

biu::Point3D< int >::operator std::vector (  )  const [inline, inherited]

Definition at line 76 of file Point.hh.

bool biu::Point3D< int >::operator!= ( const Point3D< int > &  p2  )  const [inline, inherited]

Definition at line 137 of file Point.hh.

Point3D biu::Point3D< int >::operator+ ( const Point3D< int > &  p2  )  const [inline, inherited]

Definition at line 113 of file Point.hh.

Point3D& biu::Point3D< int >::operator+= ( const int &  d  )  [inline, inherited]

Definition at line 88 of file Point.hh.

Point3D& biu::Point3D< int >::operator+= ( const Point3D< int > &  p2  )  [inline, inherited]

Definition at line 83 of file Point.hh.

Point3D& biu::Point3D< int >::operator- (  )  [inline, inherited]

Definition at line 121 of file Point.hh.

Point3D biu::Point3D< int >::operator- ( const Point3D< int > &  p2  )  const [inline, inherited]

Definition at line 117 of file Point.hh.

Point3D& biu::Point3D< int >::operator-= ( const int &  d  )  [inline, inherited]

Definition at line 98 of file Point.hh.

Point3D& biu::Point3D< int >::operator-= ( const Point3D< int > &  p2  )  [inline, inherited]

Definition at line 93 of file Point.hh.

Point3D& biu::Point3D< int >::operator/= ( const int &  d  )  [inline, inherited]

Definition at line 108 of file Point.hh.

bool biu::Point3D< int >::operator< ( const Point3D< int > &  p2  )  const [inline, inherited]

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

Definition at line 147 of file Point.hh.

bool biu::Point3D< int >::operator== ( const Point3D< int > &  p2  )  const [inline, inherited]

Definition at line 133 of file Point.hh.

bool biu::Point3D< int >::operator> ( const Point3D< int > &  p2  )  const [inline, inherited]

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

Definition at line 154 of file Point.hh.

void biu::Point3D< int >::setX ( const int &  x_  )  [inline, inherited]

Definition at line 184 of file Point.hh.

void biu::Point3D< int >::setY ( const int &  y_  )  [inline, inherited]

Definition at line 185 of file Point.hh.

void biu::Point3D< int >::setZ ( const int &  z_  )  [inline, inherited]

Definition at line 186 of file Point.hh.

double biu::Point3D< int >::vectorLength (  )  const [inline, inherited]

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

std::ostream& operator<< ( std::ostream &  out,
const Point3D< int > &  p 
) [friend, inherited]

Definition at line 175 of file Point.hh.


Field Documentation

the rotation automorphism to convert absolute to relative moves

Definition at line 42 of file NeighborVector.hh.

the vector specific internal move representation

Definition at line 36 of file NeighborVector.hh.

the rotation automorphism to convert relative to absolute moves

Definition at line 39 of file NeighborVector.hh.


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