BALL::HashGrid3< Item > Class Template Reference
[Three-dimensional Hash Grid]

#include <BALL/DATATYPE/hashGrid.h>

List of all members.

Classes

class  BoxIteratorTraits

Public Member Functions

Constructors and destructor

 HashGrid3 ()
 Default constructor.
 HashGrid3 (const Vector3 &origin, Size dimension_x, Size dimension_y, Size dimension_z, float spacing_x, float spacing_y, float spacing_z)
 HashGrid3 (const Vector3 &origin, Size dimension_x, Size dimension_y, Size dimension_z, float spacing)
 HashGrid3 (const Vector3 &origin, const Vector3 &size, float spacing)
 HashGrid3 (const HashGrid3 &grid, bool deep=true)
 Copy constructor.
virtual ~HashGrid3 ()
 Destructor.
virtual void clear ()
 Clears the whole grid.
void clear (Position x, Position y, Position z)
 Clears the HashGridBox3 at position (x, y, z).
void clear (const Vector3 &vector)
 Clears the HashGridBox3 at position vector
void destroy ()
 Destroys the grid (obsolete, only calls clear()).
void destroy (Position x, Position y, Position z)
 Destroys a box of the grid (obsolete, only calls clear()).
void destroy (const Vector3 &vector)
 Destroys a box of the grid (obsolete, only calls clear()).
Assignment

void set (const Vector3 &origin, const Vector3 &unit, Size dimension_x, Size dimension_y, Size dimension_z)
 assigns the content of a hash grid (obsolete)
void set (const Vector3 &origin, float unit, Size size)
 assigns the content of a hash grid (obsolete)
void set (const HashGrid3 &grid, bool deep=true)
 assigns the content of a hash grid (obsolete)
const HashGrid3 & operator= (const HashGrid3 &grid)
 Assignment operator.
void get (Vector3 &origin, Vector3 &unit, Size &dimension_x, Size &dimension_y, Size &dimension_z) const
void get (HashGrid3 &grid, bool deep=true) const
Accessors

Size countNonEmptyBoxes () const
 Counts the non-empty boxes of a grid.
Size getSize () const
 Returns the size of a grid, i. e. ?????
Vector3 & getOrigin ()
 Returns the origin of the grid.
const Vector3 & getOrigin () const
 Returns a const reference of the grid origin.
Vector3 & getUnit ()
 Returns the unit of the grid.
const Vector3 & getUnit () const
 Returns the unit of the grid (const version).
Size getSizeX () const
 Get the x dimension of the grid.
Size getSizeY () const
 Get the y dimension of the grid.
Size getSizeZ () const
 Get the z dimension of the grid.
HashGridBox3< Item > * getBox (Position x, Position y, Position z)
 Return the HashGridBox3 at position (x, y, z).
const HashGridBox3< Item > * getBox (Position x, Position y, Position z) const
 Return the HashGridBox3 at position (x, y, z) (const version).
HashGridBox3< Item > * getBox (const Vector3 &vector)
 Return the HashGridBox3 at position vector.
const HashGridBox3< Item > * getBox (const Vector3 &vector) const
 Return the HashGridBox3 at position vector (const version).
bool getIndices (const HashGridBox3< Item > &box, Position &x, Position &y, Position &z) const
 Get the position indices of a HashGridBox3.
void insert (Position x, Position y, Position z, const Item &item)
 Insert an item at position (x, y, z).
void insert (const Vector3 &vector, const Item &item)
 Insert an item at position vector
bool remove (Position x, Position y, Position z, const Item &item)
 Remove an item from position (x, y ,z).
bool remove (const Vector3 &vector, const Item &item)
 Remove an item from position vector
Miscellaneous

void host (Visitor< HashGrid3 > &visitor)
Predicates

bool operator== (const HashGrid3 &grid) const
 Equality operator.
bool operator!= (const HashGrid3 &grid) const
 Inequality operator.
bool isEmpty () const
 Tests, whether this is empty.
Debugging and Diagnostics

virtual bool isValid () const
 Validity check.
virtual void dump (std::ostream &s=std::cout, Size depth=0) const
 Dump the contents of a HashGrid3 to a stream.

Private Member Functions

Index getIndex_ (const HashGridBox3< Item > &box) const

Private Attributes

Vector3 origin_
Vector3 unit_
Size dimension_x_
Size dimension_y_
Size dimension_z_
vector< HashGridBox3< Item > > box_

External Iterators



typedef Position BoxIteratorPosition
typedef ForwardIterator
< HashGrid3< Item >
, HashGridBox3< Item >
, BoxIteratorPosition,
BoxIteratorTraits > 		BoxIterator
typedef ConstForwardIterator
< HashGrid3< Item >
, HashGridBox3< Item >
, BoxIteratorPosition,
BoxIteratorTraits > 		ConstBoxIterator
class BoxIteratorTraits
BoxIterator beginBox ()
BoxIterator endBox ()
ConstBoxIterator beginBox () const
ConstBoxIterator endBox () const

Internal Iterators



bool apply (UnaryProcessor< Item > &processor)
bool apply (UnaryProcessor< HashGridBox3< Item > > &processor)
const Item * getClosestItem (const Vector3 &point, Size distance) const
static float calculateMinSpacing (LongIndex memory, const Vector3 &size)

Detailed Description

template<typename Item>
class BALL::HashGrid3< Item >

Three-dimensional Hash Grid Class. ?????

Definition at line 760 of file hashGrid.h.

Member Typedef Documentation

template<typename Item>
typedef ForwardIterator<HashGrid3<Item>, HashGridBox3<Item>, BoxIteratorPosition, BoxIteratorTraits> BALL::HashGrid3< Item >::BoxIterator

Definition at line 1102 of file hashGrid.h.

template<typename Item>
typedef Position BALL::HashGrid3< Item >::BoxIteratorPosition

Definition at line 974 of file hashGrid.h.

template<typename Item>
typedef ConstForwardIterator<HashGrid3<Item>, HashGridBox3<Item>, BoxIteratorPosition, BoxIteratorTraits> BALL::HashGrid3< Item >::ConstBoxIterator

Definition at line 1121 of file hashGrid.h.

Constructor & Destructor Documentation

template<typename Item >
BALL::HashGrid3< Item >::HashGrid3 (  )  [inline]

Default constructor.

Definition at line 1161 of file hashGrid.h.

template<typename Item >
BALL::HashGrid3< Item >::HashGrid3 ( const Vector3 &  origin,
Size  dimension_x,
Size  dimension_y,
Size  dimension_z,
float  spacing_x,
float  spacing_y,
float  spacing_z 
) [inline]

Constructor using origin, dimensions, and spacings of the grid. It creates a hashgrid at origin with axis-dependant spacings.

Parameters:
origin 
dimension_x 
dimension_y 
dimension_z 
spacing_x 
spacing_y 
spacing_z 

Definition at line 1172 of file hashGrid.h.

template<typename Item >
BALL::HashGrid3< Item >::HashGrid3 ( const Vector3 &  origin,
Size  dimension_x,
Size  dimension_y,
Size  dimension_z,
float  spacing 
) [inline]

Constructor using origin, dimensions, and a single spacing (only cubic grids)

Definition at line 1186 of file hashGrid.h.

template<typename Item >
BALL::HashGrid3< Item >::HashGrid3 ( const Vector3 &  origin,
const Vector3 &  size,
float  spacing 
) [inline]

Constructor using two vectors and a single spacing. This constructor creates a hash grid at origin with spacing spacing. The vector size has to be relative to origin and defines the opposite corner of the grid, thereby setting the size of the grid.

Parameters:
origin a vector defining the origin of our cubic hash grid
size a vector defining the opposite corner of the cubic grid
spacing this float will be used as spacing in all three dimensions

Definition at line 1199 of file hashGrid.h.

template<typename Item >
BALL::HashGrid3< Item >::HashGrid3 ( const HashGrid3< Item > &  grid,
bool  deep = true 
) [inline]

Copy constructor.

Definition at line 1211 of file hashGrid.h.

template<typename Item >
BALL::HashGrid3< Item >::~HashGrid3 (  )  [inline, virtual]

Destructor.

Definition at line 1217 of file hashGrid.h.

Member Function Documentation

template<typename Item>
bool BALL::HashGrid3< Item >::apply ( UnaryProcessor< HashGridBox3< Item > > &  processor  )  [inline]

Definition at line 1720 of file hashGrid.h.

template<typename Item>
bool BALL::HashGrid3< Item >::apply ( UnaryProcessor< Item > &  processor  )  [inline]

Definition at line 1694 of file hashGrid.h.

template<typename Item>
ConstBoxIterator BALL::HashGrid3< Item >::beginBox (  )  const [inline]

Definition at line 1124 of file hashGrid.h.

template<typename Item>
BoxIterator BALL::HashGrid3< Item >::beginBox (  )  [inline]

Definition at line 1105 of file hashGrid.h.

template<typename Item >
BALL_INLINE float BALL::HashGrid3< Item >::calculateMinSpacing ( LongIndex  memory,
const Vector3 &  size 
) [inline, static]

Calculate the minimum required spacing to build a HashGrid3 with the given size and less than the given memory consumption.

Parameters:
memory the amount of memory in bytes
size the diagonal of the grid
Returns:
the minimal needed spacing

Definition at line 1461 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::clear ( const Vector3 &  vector  )  [inline]

Clears the HashGridBox3 at position vector

Definition at line 1246 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::clear ( Position  x,
Position  y,
Position  z 
) [inline]

Clears the HashGridBox3 at position (x, y, z).

Definition at line 1234 of file hashGrid.h.

template<typename Item >
void BALL::HashGrid3< Item >::clear (  )  [inline, virtual]

Clears the whole grid.

Definition at line 1222 of file hashGrid.h.

template<typename Item >
Size BALL::HashGrid3< Item >::countNonEmptyBoxes (  )  const [inline]

Counts the non-empty boxes of a grid.

Definition at line 1347 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::destroy ( const Vector3 &  vector  )  [inline]

Destroys a box of the grid (obsolete, only calls clear()).

Definition at line 1272 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::destroy ( Position  x,
Position  y,
Position  z 
) [inline]

Destroys a box of the grid (obsolete, only calls clear()).

Definition at line 1265 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::destroy (  )  [inline]

Destroys the grid (obsolete, only calls clear()).

Definition at line 1258 of file hashGrid.h.

template<typename Item >
void BALL::HashGrid3< Item >::dump ( std::ostream &  s = std::cout,
Size  depth = 0 
) const [inline, virtual]

Dump the contents of a HashGrid3 to a stream.

Definition at line 1646 of file hashGrid.h.

template<typename Item>
ConstBoxIterator BALL::HashGrid3< Item >::endBox (  )  const [inline]

Definition at line 1130 of file hashGrid.h.

template<typename Item>
BoxIterator BALL::HashGrid3< Item >::endBox (  )  [inline]

Definition at line 1111 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::get ( HashGrid3< Item > &  grid,
bool  deep = true 
) const [inline]

Definition at line 1340 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::get ( Vector3 &  origin,
Vector3 &  unit,
Size &  dimension_x,
Size &  dimension_y,
Size &  dimension_z 
) const [inline]

Definition at line 1328 of file hashGrid.h.

template<typename Item >
BALL_INLINE const HashGridBox3< Item > * BALL::HashGrid3< Item >::getBox ( const Vector3 &  vector  )  const [inline]

Return the HashGridBox3 at position vector (const version).

Definition at line 1510 of file hashGrid.h.

template<typename Item >
BALL_INLINE HashGridBox3< Item > * BALL::HashGrid3< Item >::getBox ( const Vector3 &  vector  )  [inline]

Return the HashGridBox3 at position vector.

Definition at line 1494 of file hashGrid.h.

template<typename Item >
BALL_INLINE const HashGridBox3< Item > * BALL::HashGrid3< Item >::getBox ( Position  x,
Position  y,
Position  z 
) const [inline]

Return the HashGridBox3 at position (x, y, z) (const version).

Definition at line 1487 of file hashGrid.h.

template<typename Item >
BALL_INLINE HashGridBox3< Item > * BALL::HashGrid3< Item >::getBox ( Position  x,
Position  y,
Position  z 
) [inline]

Return the HashGridBox3 at position (x, y, z).

Definition at line 1471 of file hashGrid.h.

template<typename Item >
const Item * BALL::HashGrid3< Item >::getClosestItem ( const Vector3 &  point,
Size  distance 
) const [inline]

Get the nearest item for a point

Parameters:
distance number of adjacted boxes in each direction to search in

Definition at line 1417 of file hashGrid.h.

template<typename Item>
BALL_INLINE Index BALL::HashGrid3< Item >::getIndex_ ( const HashGridBox3< Item > &  box  )  const [inline, private]

Definition at line 1745 of file hashGrid.h.

template<typename Item>
BALL_INLINE bool BALL::HashGrid3< Item >::getIndices ( const HashGridBox3< Item > &  box,
Position &  x,
Position &  y,
Position &  z 
) const [inline]

Get the position indices of a HashGridBox3.

Definition at line 1518 of file hashGrid.h.

template<typename Item >
BALL_INLINE const Vector3 & BALL::HashGrid3< Item >::getOrigin (  )  const [inline]

Returns a const reference of the grid origin.

Definition at line 1376 of file hashGrid.h.

template<typename Item >
BALL_INLINE Vector3 & BALL::HashGrid3< Item >::getOrigin (  )  [inline]

Returns the origin of the grid.

Definition at line 1369 of file hashGrid.h.

template<typename Item >
BALL_INLINE Size BALL::HashGrid3< Item >::getSize (  )  const [inline]

Returns the size of a grid, i. e. ?????

Definition at line 1362 of file hashGrid.h.

template<typename Item >
BALL_INLINE Size BALL::HashGrid3< Item >::getSizeX (  )  const [inline]

Get the x dimension of the grid.

Definition at line 1397 of file hashGrid.h.

template<typename Item >
BALL_INLINE Size BALL::HashGrid3< Item >::getSizeY (  )  const [inline]

Get the y dimension of the grid.

Definition at line 1404 of file hashGrid.h.

template<typename Item >
BALL_INLINE Size BALL::HashGrid3< Item >::getSizeZ (  )  const [inline]

Get the z dimension of the grid.

Definition at line 1411 of file hashGrid.h.

template<typename Item >
BALL_INLINE const Vector3 & BALL::HashGrid3< Item >::getUnit (  )  const [inline]

Returns the unit of the grid (const version).

Definition at line 1390 of file hashGrid.h.

template<typename Item >
BALL_INLINE Vector3 & BALL::HashGrid3< Item >::getUnit (  )  [inline]

Returns the unit of the grid.

Definition at line 1383 of file hashGrid.h.

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::host ( Visitor< HashGrid3< Item > > &  visitor  )  [inline]

Definition at line 1593 of file hashGrid.h.

template<typename Item>
BALL_INLINE void BALL::HashGrid3< Item >::insert ( const Vector3 &  vector,
const Item &  item 
) [inline]

Insert an item at position vector

Definition at line 1553 of file hashGrid.h.

template<typename Item>
BALL_INLINE void BALL::HashGrid3< Item >::insert ( Position  x,
Position  y,
Position  z,
const Item &  item 
) [inline]

Insert an item at position (x, y, z).

Definition at line 1541 of file hashGrid.h.

template<typename Item >
BALL_INLINE bool BALL::HashGrid3< Item >::isEmpty (  )  const [inline]

Tests, whether this is empty.

Definition at line 1624 of file hashGrid.h.

template<typename Item >
bool BALL::HashGrid3< Item >::isValid (  )  const [inline, virtual]

Validity check.

Definition at line 1630 of file hashGrid.h.

template<typename Item >
BALL_INLINE bool BALL::HashGrid3< Item >::operator!= ( const HashGrid3< Item > &  grid  )  const [inline]

Inequality operator.

Definition at line 1617 of file hashGrid.h.

template<typename Item >
BALL_INLINE const HashGrid3< Item > & BALL::HashGrid3< Item >::operator= ( const HashGrid3< Item > &  grid  )  [inline]

Assignment operator.

Definition at line 1319 of file hashGrid.h.

template<typename Item >
BALL_INLINE bool BALL::HashGrid3< Item >::operator== ( const HashGrid3< Item > &  grid  )  const [inline]

Equality operator.

Definition at line 1600 of file hashGrid.h.

template<typename Item>
BALL_INLINE bool BALL::HashGrid3< Item >::remove ( const Vector3 &  vector,
const Item &  item 
) [inline]

Remove an item from position vector

Definition at line 1579 of file hashGrid.h.

template<typename Item>
BALL_INLINE bool BALL::HashGrid3< Item >::remove ( Position  x,
Position  y,
Position  z,
const Item &  item 
) [inline]

Remove an item from position (x, y ,z).

Definition at line 1565 of file hashGrid.h.

template<typename Item >
void BALL::HashGrid3< Item >::set ( const HashGrid3< Item > &  grid,
bool  deep = true 
) [inline]

assigns the content of a hash grid (obsolete)

Definition at line 1302 of file hashGrid.h.

template<typename Item >
void BALL::HashGrid3< Item >::set ( const Vector3 &  origin,
float  unit,
Size  size 
) [inline]

assigns the content of a hash grid (obsolete)

Definition at line 1291 of file hashGrid.h.

template<typename Item >
void BALL::HashGrid3< Item >::set ( const Vector3 &  origin,
const Vector3 &  unit,
Size  dimension_x,
Size  dimension_y,
Size  dimension_z 
) [inline]

assigns the content of a hash grid (obsolete)

Definition at line 1279 of file hashGrid.h.

Friends And Related Function Documentation

template<typename Item>
friend class BoxIteratorTraits [friend]

Definition at line 1096 of file hashGrid.h.

Member Data Documentation

template<typename Item>
vector<HashGridBox3<Item> > BALL::HashGrid3< Item >::box_ [private]

Definition at line 1153 of file hashGrid.h.

template<typename Item>
Size BALL::HashGrid3< Item >::dimension_x_ [private]

Definition at line 1147 of file hashGrid.h.

template<typename Item>
Size BALL::HashGrid3< Item >::dimension_y_ [private]

Definition at line 1149 of file hashGrid.h.

template<typename Item>
Size BALL::HashGrid3< Item >::dimension_z_ [private]

Definition at line 1151 of file hashGrid.h.

template<typename Item>
Vector3 BALL::HashGrid3< Item >::origin_ [private]

Definition at line 1143 of file hashGrid.h.

template<typename Item>
Vector3 BALL::HashGrid3< Item >::unit_ [private]

Definition at line 1145 of file hashGrid.h.

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines
Generated by  doxygen 1.6.3