BALL::HashGrid3< Item > Class Template Reference

#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 HashGrid3operator= (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. ?????
Vector3getOrigin ()
 Returns the origin of the grid.
const Vector3getOrigin () const
 Returns a const reference of the grid origin.
Vector3getUnit ()
 Returns the unit of the grid.
const Vector3getUnit () 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
void setNeighbours_ ()
 update the neighbour information in the individual boxes

Private Attributes

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

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)

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

Detailed Description

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

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


Member Typedef Documentation

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

Constructor & Destructor Documentation

template<typename Item >
BALL::HashGrid3< Item >::HashGrid3 ( )

Default constructor.

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 
)

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
template<typename Item >
BALL::HashGrid3< Item >::HashGrid3 ( const Vector3 origin,
Size  dimension_x,
Size  dimension_y,
Size  dimension_z,
float  spacing 
)

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

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

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:
origina vector defining the origin of our cubic hash grid
sizea vector defining the opposite corner of the cubic grid
spacingthis float will be used as spacing in all three dimensions

References BALL::HashGrid3< Item >::box_, BALL::HashGrid3< Item >::dimension_x_, BALL::HashGrid3< Item >::dimension_y_, BALL::HashGrid3< Item >::dimension_z_, and BALL::HashGrid3< Item >::setNeighbours_().

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

Copy constructor.

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

Destructor.


Member Function Documentation

template<typename Item>
bool BALL::HashGrid3< Item >::apply ( UnaryProcessor< HashGridBox3< Item > > &  processor)
template<typename Item>
BoxIterator BALL::HashGrid3< Item >::beginBox ( ) [inline]
template<typename Item>
ConstBoxIterator BALL::HashGrid3< Item >::beginBox ( ) const [inline]
template<typename Item >
BALL_INLINE float BALL::HashGrid3< Item >::calculateMinSpacing ( LongIndex  memory,
const Vector3 size 
) [static]

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

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

References BALL::Maths::floor(), BALL::TVector3< T >::x, BALL::TVector3< T >::y, and BALL::TVector3< T >::z.

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

Clears the whole grid.

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

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

References BALL::HashGridBox3< Item >::clear().

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

Clears the HashGridBox3 at position vector

References BALL::HashGridBox3< Item >::clear().

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

Counts the non-empty boxes of a grid.

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

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

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

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

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

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

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

Dump the contents of a HashGrid3 to a stream.

References BALL_DUMP_DEPTH, BALL_DUMP_STREAM_PREFIX, and BALL_DUMP_STREAM_SUFFIX.

template<typename Item>
BoxIterator BALL::HashGrid3< Item >::endBox ( ) [inline]
template<typename Item>
ConstBoxIterator BALL::HashGrid3< Item >::endBox ( ) const [inline]
template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::get ( Vector3 origin,
Vector3 unit,
Size dimension_x,
Size dimension_y,
Size dimension_z 
) const
template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::get ( HashGrid3< Item > &  grid,
bool  deep = true 
) const
template<typename Item >
BALL_INLINE HashGridBox3< Item > * BALL::HashGrid3< Item >::getBox ( Position  x,
Position  y,
Position  z 
)

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

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

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

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

Return the HashGridBox3 at position vector (const version)

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

Get the nearest item for a point

Parameters:
distancenumber of adjacted boxes in each direction to search in

References BALL::HashGridBox3< Item >::beginData(), BALL::HashGridBox3< Item >::endData(), and BALL::HashGridBox3< Item >::isEmpty().

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

References BALL::INVALID_INDEX.

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

Get the position indices of a HashGridBox3.

References BALL::INVALID_INDEX, and BALL::INVALID_POSITION.

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

Returns a const reference of the grid origin.

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

Returns the origin of the grid.

template<typename Item >
BALL_INLINE Size BALL::HashGrid3< Item >::getSize ( ) const
template<typename Item >
BALL_INLINE Size BALL::HashGrid3< Item >::getSizeX ( ) const

Get the x dimension of the grid.

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

Get the y dimension of the grid.

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

Get the z dimension of the grid.

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

Returns the unit of the grid.

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

Returns the unit of the grid (const version)

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::host ( Visitor< HashGrid3< Item > > &  visitor)
template<typename Item>
BALL_INLINE void BALL::HashGrid3< Item >::insert ( Position  x,
Position  y,
Position  z,
const Item &  item 
)

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

References BALL::HashGridBox3< Item >::insert().

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

Insert an item at position vector

References BALL::HashGridBox3< Item >::insert().

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

Tests, whether this is empty.

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

Validity check.

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

Inequality operator.

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

Assignment operator.

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

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

References BALL::HashGridBox3< Item >::remove().

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

Remove an item from position vector

References BALL::HashGridBox3< Item >::remove().

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

assigns the content of a hash grid (obsolete)

Referenced by BALL::HashGrid3< Item >::get().

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

assigns the content of a hash grid (obsolete)

template<typename Item >
BALL_INLINE void BALL::HashGrid3< Item >::setNeighbours_ ( ) [private]

update the neighbour information in the individual boxes

Referenced by BALL::HashGrid3< Item >::HashGrid3().


Friends And Related Function Documentation

template<typename Item>
friend class BoxIteratorTraits [friend]

Member Data Documentation

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