Three-dimensional Hash Grid

Classes
class	BALL::HashGridBox3< Item >
class	BALL::HashGrid3< Item >

Constructors and Destructors
	BALL::HashGridBox3< Item >::HashGridBox3 (HashGrid3< Item > *parent)
	Default constructor. More...
void	BALL::HashGridBox3< Item >::clear ()
	Clears the grid box. More...
void	BALL::HashGridBox3< Item >::destroy ()

Accessors
void	BALL::HashGridBox3< Item >::setParent (HashGrid3< Item > *p)
void	BALL::HashGridBox3< Item >::getIndices (Position &x, Position &y, Position &z)
Item *	BALL::HashGridBox3< Item >::find (const Item &item)
const Item *	BALL::HashGridBox3< Item >::find (const Item &item) const
	The const version of find() More...
Size	BALL::HashGridBox3< Item >::getSize () const
void	BALL::HashGridBox3< Item >::insert (const Item &item)
bool	BALL::HashGridBox3< Item >::remove (const Item &item)
bool	BALL::HashGridBox3< Item >::removeAll (const Item &item)

Miscellaneous
void	BALL::HashGridBox3< Item >::host (Visitor< HashGridBox3 > &visitor)
	Host method. More...

Predicates
bool	BALL::HashGridBox3< Item >::operator== (const HashGridBox3 &box) const
	Equality operator. More...
bool	BALL::HashGridBox3< Item >::operator!= (const HashGridBox3 &box) const
	Inequality operator. More...
bool	BALL::HashGridBox3< Item >::has (const Item &item) const
bool	BALL::HashGridBox3< Item >::isEmpty () const

Debugging and Diagnostics
bool	BALL::HashGridBox3< Item >::isValid () const
void	BALL::HashGridBox3< Item >::dump (std::ostream &s=std::cout, Size depth=0) const

Internal Iterators
bool	BALL::HashGridBox3< Item >::apply (UnaryProcessor< Item > &processor)
bool	BALL::HashGridBox3< Item >::apply (UnaryProcessor< HashGridBox3< Item > > &processor)

Detailed Description

Function Documentation

template<typename Item>

BALL::HashGridBox3< Item >::HashGridBox3

(

HashGrid3< Item > *

parent

)

Default constructor.

Definition at line 533 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::apply

(

UnaryProcessor< Item > &

processor

)

Definition at line 710 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::apply

(

UnaryProcessor< HashGridBox3< Item > > &

processor

)

Definition at line 733 of file hashGrid.h.

template<typename Item >

void BALL::HashGridBox3< Item >::clear

(

)

Clears the grid box.

Definition at line 539 of file hashGrid.h.

template<typename Item >

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

(

)

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

Definition at line 689 of file hashGrid.h.

template<typename Item>

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

(

const Item &

item

)

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 const Item * BALL::HashGridBox3< Item >::find

(

const Item &

item

)

const

The const version of find()

Definition at line 579 of file hashGrid.h.

template<typename Item >

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

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

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

Test whether an item is in the data item list

Parameters

item

Returns

bool - true if instance has item, false otherwise.

Definition at line 669 of file hashGrid.h.

template<typename Item>

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

(

Visitor< HashGridBox3< Item > > &

visitor

)

Host method.

Definition at line 649 of file hashGrid.h.

template<typename Item>

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

(

const Item &

item

)

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

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 676 of file hashGrid.h.

template<typename Item >

bool BALL::HashGridBox3< Item >::isValid

(

)

const

Definition at line 682 of file hashGrid.h.

template<typename Item>

BALL_INLINE bool BALL::HashGridBox3< Item >::operator!=

(

const HashGridBox3< Item > &

box

)

const

Inequality operator.

Definition at line 662 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::operator==

(

const HashGridBox3< Item > &

box

)

const

Equality operator.

Definition at line 655 of file hashGrid.h.

template<typename Item>

bool BALL::HashGridBox3< Item >::remove

(

const Item &

item

)

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

)

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 640 of file hashGrid.h.

template<typename Item>

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

(

HashGrid3< Item > *

p

)

Definition at line 552 of file hashGrid.h.