Three-dimensional Hash Grid
[Generic Hash Associative Containers]

Collaboration diagram for Three-dimensional Hash Grid:

Classes
class	BALL::HashGridBox3< Item >
	Grid Box Class. More...
class	BALL::HashGrid3< Item >
	Three-dimensional Hash Grid Class. More...
Constructors and Destructors
	BALL::HashGridBox3::HashGridBox3 ()
	Default constructor.
	BALL::HashGridBox3::HashGridBox3 (const HashGridBox3 &grid_box, bool deep=true)
	Copy constructor.
	BALL::HashGridBox3::~HashGridBox3 ()
	Destructor.
void	BALL::HashGridBox3::clear ()
	Clears the grid box.
void	BALL::HashGridBox3::destroy ()
	Clears the grid box.
Assignment
void	BALL::HashGridBox3::set (const HashGridBox3 &box, bool=true) throw (Exception::NotImplemented)
const HashGridBox3 &	BALL::HashGridBox3::operator= (const HashGridBox3 &box) throw (Exception::NotImplemented)
Accessors
Item *	BALL::HashGridBox3::find (const Item &item)
	Find an item in the item list of this grid box.
const Item *	BALL::HashGridBox3::find (const Item &item) const
	The const version of find().
Size	BALL::HashGridBox3::getSize () const
	Counts all items in the data item list.
void	BALL::HashGridBox3::insert (const Item &item)
	Insert an item into the data item list of a grid box.
bool	BALL::HashGridBox3::remove (const Item &item)
	Remove the first occurrence of a certain item from the data item list.
bool	BALL::HashGridBox3::removeAll (const Item &item)
	Remove all occurences of a certain item from the data item list.
Miscellaneous
void	BALL::HashGridBox3::host (Visitor< HashGridBox3 > &visitor)
	Host method.
Predicates
bool	BALL::HashGridBox3::operator== (const HashGridBox3 &box) const
	Equality operator.
bool	BALL::HashGridBox3::operator!= (const HashGridBox3 &box) const
	Inequality operator.
bool	BALL::HashGridBox3::has (const Item &item) const
	Test whether an item is in the data item list.
bool	BALL::HashGridBox3::isEmpty () const
	Test, whether this box is empty, i.
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 >

void BALL::HashGridBox3< Item >::destroy

(

)

[inherited]

Clears the grid box.

Same as clear.

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

template<typename Item>

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

(

const Item &

item

)

[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.

References BALL::HashGridBox3< Item >::HashGridBox3::DataItem::next_.

Referenced by BALL::HashGridBox3< Item >::find(), and BALL::HashGridBox3< Item >::has().

template<typename Item >

Size BALL::HashGridBox3< Item >::getSize

(

)

const [inherited]

Counts all items in the data item list.

Returns:

the size of the data item list.

References BALL::HashGridBox3< Item >::HashGridBox3::DataItem::next_.

template<typename Item>

bool BALL::HashGridBox3< Item >::has

(

const Item &

item

)

const [inherited]

Test whether an item is in the data item list.

Parameters:

item

Returns:

bool - true if instance has item, false otherwise.

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

template<typename Item>

void BALL::HashGridBox3< Item >::insert

(

const Item &

item

)

[inherited]

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

Parameters:

item

the item to be inserted

Referenced by BALL::HashGrid3< Item >::insert(), and BALL::HashGrid3< Item >::set().

template<typename Item >

bool BALL::HashGridBox3< Item >::isEmpty

(

)

const [inherited]

Test, whether this box is empty, i.

e. the data item list contains nothing

Returns:

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

Referenced by BALL::HashGrid3< Item >::getClosestItem(), and BALL::HashGrid3< Item >::set().

template<typename Item>

bool BALL::HashGridBox3< Item >::remove

(

const Item &

item

)

[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.

References BALL::HashGridBox3< Item >::HashGridBox3::DataItem::next_, and BALL::HashGridBox3< Item >::HashGridBox3::DataItem::previous_.

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

template<typename Item>

bool BALL::HashGridBox3< Item >::removeAll

(

const Item &

item

)

[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.

References BALL::HashGridBox3< Item >::HashGridBox3::DataItem::item_, BALL::HashGridBox3< Item >::HashGridBox3::DataItem::next_, and BALL::HashGridBox3< Item >::HashGridBox3::DataItem::previous_.