Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

Three-dimensional Hash Grid
[Generic Hash Associative Containers]


Classes

class  HashGridBox3< Item >
 Grid Box Class. More...
class  HashGridBox3< Item >
 Grid Box Class. More...
class  HashGrid3< Item >
 Three-dimensional Hash Grid Class. More...

Constructors and Destructors

 HashGridBox3::HashGridBox3 () throw ()
 Default constructor.
 HashGridBox3::HashGridBox3 (const HashGridBox3 &grid_box, bool deep=true) throw ()
 Copy constructor.
 HashGridBox3::~HashGridBox3 () throw ()
 Destructor.
void HashGridBox3::clear () throw ()
 Clears the grid box.
void HashGridBox3::destroy () throw ()
 Clears the grid box.

Assignment

void set (const HashGridBox3 &box, bool=true) throw (Exception::NotImplemented)
const HashGridBox3 & operator= (const HashGridBox3 &box) throw (Exception::NotImplemented)

Accessors

Item * HashGridBox3::find (const Item &item) throw ()
 Find an item in the item list of this grid box.
const Item * HashGridBox3::find (const Item &item) const throw ()
 The const version of find().
Size HashGridBox3::getSize () const throw ()
 Counts all items in the data item list.
void HashGridBox3::insert (const Item &item) throw ()
 Insert an item into the data item list of a grid box.
bool HashGridBox3::remove (const Item &item) throw ()
 Remove the first occurrence of a certain item from the data item list.
bool HashGridBox3::removeAll (const Item &item) throw ()
 Remove all occurences of a certain item from the data item list.

Miscellaneous

void HashGridBox3::host (Visitor< HashGridBox3 > &visitor) throw ()
 Host method.

Predicates

bool HashGridBox3::operator== (const HashGridBox3 &box) const throw ()
 Equality operator.
bool HashGridBox3::operator!= (const HashGridBox3 &box) const throw ()
 Inequality operator.
bool HashGridBox3::has (const Item &item) const throw ()
 Test whether an item is in the data item list.
bool HashGridBox3::isEmpty () const throw ()
 Test, whether this box is empty, i.

Debugging and Diagnostics

bool isValid () const throw ()
void dump (std::ostream &s=std::cout, Size depth=0) const throw ()

Internal Iterators

bool apply (UnaryProcessor< Item > &processor) throw ()
bool apply (UnaryProcessor< HashGridBox3< Item > > &processor) throw ()

Functions

void insert_ (HashGridBox3 *box) throw ()
bool remove_ (HashGridBox3 *box) throw ()

Detailed Description


Function Documentation

template<typename Item>
void HashGridBox3< Item >::destroy  )  throw () [inherited]
 

Clears the grid box.

Same as clear.

template<typename Item>
Item * HashGridBox3< Item >::find const Item &  item  )  throw () [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.

template<typename Item>
Size HashGridBox3< Item >::getSize  )  const throw () [inherited]
 

Counts all items in the data item list.

Returns:
the size of the data item list.

template<typename Item>
bool HashGridBox3< Item >::has const Item &  item  )  const throw () [inherited]
 

Test whether an item is in the data item list.

Parameters:
item 
Returns:
bool - true if instance has item, false otherwise.

template<typename Item>
void HashGridBox3< Item >::insert const Item &  item  )  throw () [inherited]
 

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

Parameters:
item the item to be inserted

template<typename Item>
bool HashGridBox3< Item >::isEmpty  )  const throw () [inherited]
 

Test, whether this box is empty, i.

e. the data item list contains nothing

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

template<typename Item>
bool HashGridBox3< Item >::remove const Item &  item  )  throw () [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.

template<typename Item>
bool HashGridBox3< Item >::removeAll const Item &  item  )  throw () [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.