Three-dimensional Hash Grid
[Generic Hash Associative Containers]

Classes
class	BALL::HashGridBox3< Item >
class	BALL::HashGrid3< Item >
Constructors and Destructors
	BALL::HashGridBox3::HashGridBox3 (HashGrid3< Item > *parent)
	Default constructor.
void	BALL::HashGridBox3::clear ()
	Clears the grid box.
void	BALL::HashGridBox3::destroy ()
Accessors
void	BALL::HashGridBox3::setParent (HashGrid3< Item > *p)
void	BALL::HashGridBox3::getIndices (Position &x, Position &y, Position &z)
Item *	BALL::HashGridBox3::find (const Item &item)
const Item *	BALL::HashGridBox3::find (const Item &item) const
	The const version of find().
Size	BALL::HashGridBox3::getSize () const
void	BALL::HashGridBox3::insert (const Item &item)
bool	BALL::HashGridBox3::remove (const Item &item)
bool	BALL::HashGridBox3::removeAll (const Item &item)
Predicates
bool	BALL::HashGridBox3::has (const Item &item) const
bool	BALL::HashGridBox3::isEmpty () const
Debugging and Diagnostics
bool	BALL::HashGridBox3::isValid () const
void	BALL::HashGridBox3::dump (std::ostream &s=std::cout, Size depth=0) const
Internal Iterators
bool	BALL::HashGridBox3::apply (UnaryProcessor< Item > &processor)
bool	BALL::HashGridBox3::apply (UnaryProcessor< HashGridBox3< Item > > &processor)

---

Function Documentation

template<typename Item>

BALL::HashGridBox3< Item >::HashGridBox3

(

HashGrid3< Item > *

parent

)

[inline, inherited]

Default constructor.

Definition at line 533 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::apply

(

UnaryProcessor< HashGridBox3< Item > > &

processor

)

[inline, inherited]

Definition at line 728 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::apply

(

UnaryProcessor< Item > &

processor

)

[inline, inherited]

Definition at line 705 of file hashGrid.h.

template<typename Item >

void BALL::HashGridBox3< Item >::clear

(

)

[inline, inherited]

Clears the grid box.

Definition at line 539 of file hashGrid.h.

template<typename Item >

BALL_INLINE void BALL::HashGridBox3< Item >::destroy

(

)

[inline, inherited]

Clears the grid box. Same as clear.

Definition at line 546 of file hashGrid.h.

template<typename Item >

void BALL::HashGridBox3< Item >::dump	(	std::ostream &	s = std::cout,
		Size	depth = 0
	)			const [inline, inherited]

Definition at line 684 of file hashGrid.h.

template<typename Item>

BALL_INLINE const Item * BALL::HashGridBox3< Item >::find

(

const Item &

item

)

const [inline, inherited]

The const version of find().

Definition at line 579 of file hashGrid.h.

template<typename Item>

Item * BALL::HashGridBox3< Item >::find

(

const Item &

item

)

[inline, inherited]

Find an item in the item list of this grid box.

Parameters:

item

the item to be searched for

Returns:

a pointer to the desired item or a NULL pointer, if the item could not be found.

Definition at line 565 of file hashGrid.h.

template<typename Item >

BALL_INLINE void BALL::HashGridBox3< Item >::getIndices	(	Position &	x,
		Position &	y,
		Position &	z
	)			[inline, inherited]

Return the indices of this box in the parent HashGrid

Definition at line 559 of file hashGrid.h.

template<typename Item >

Size BALL::HashGridBox3< Item >::getSize

(

)

const [inline, inherited]

Counts all items in the data item list.

Returns:

the size of the data item list.

Definition at line 585 of file hashGrid.h.

template<typename Item>

BALL_INLINE bool BALL::HashGridBox3< Item >::has

(

const Item &

item

)

const [inline, inherited]

Test whether an item is in the data item list

Parameters:

item

Returns:

bool - true if instance has item, false otherwise.

Definition at line 664 of file hashGrid.h.

template<typename Item>

BALL_INLINE void BALL::HashGridBox3< Item >::insert

(

const Item &

item

)

[inline, inherited]

Insert an item into the data item list of a grid box.

Parameters:

item

the item to be inserted

Definition at line 592 of file hashGrid.h.

template<typename Item >

BALL_INLINE bool BALL::HashGridBox3< Item >::isEmpty

(

)

const [inline, inherited]

Test, whether this box is empty, i. e. the data item list contains nothing

Returns:

bool - true, if this is empty. false otherwise.

Definition at line 671 of file hashGrid.h.

template<typename Item >

bool BALL::HashGridBox3< Item >::isValid

(

)

const [inline, inherited]

Definition at line 677 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::remove

(

const Item &

item

)

[inline, inherited]

Remove the first occurrence of a certain item from the data item list.

Parameters:

item

the item to be removed

Returns:

bool - true, if the item could be removed, false otherwise.

Definition at line 598 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::removeAll

(

const Item &

item

)

[inline, inherited]

Remove all occurences of a certain item from the data item list.

Parameters:

item

the item to be removed

Returns:

bool - true, if the item could be removed, false otherwise.

Definition at line 635 of file hashGrid.h.

template<typename Item>

BALL_INLINE void BALL::HashGridBox3< Item >::setParent

(

HashGrid3< Item > *

p

)

[inline, inherited]

Definition at line 552 of file hashGrid.h.