Cpl::Container::Dictionary< ITEM > Class Template Reference

This template class implements a Dictionary and/or Hash Table. More...

Detailed Description

template<class ITEM>
class Cpl::Container::Dictionary< ITEM >

This template class implements a Dictionary and/or Hash Table.

Hash Collisions are handled by a simple link list for each 'hash bucket'.

o The application is responsible for providing memory for the
  Dictionary, i.e. must provide an array of DList<ITEM> where the
  size of the array is the 'number of buckets' in the hash table.

o This is no checking for duplicate keys. You can insert multiple
  items with duplicates keys, but there is no guaranty on how
  those items are found in searches and/or removed from the table.

o There is no limit to the number of items that can be
  stored in the table.  However, there is a performance
  penalty as the ratio of items vs. table buckets increases.
  Recommended size: For the default hash function use a prime
  number.  Here is a list of some useful primes:
    67, 131, 257, 521, 1031, 2053, 4099, 8209, 16411

Template ARGS: ITEM - Data type of the object stored in the dictionary. 'ITEM' must be a sub-class of the Cpl::Container::DictItem base class.

#include <Dictionary.h>

Public Member Functions
	Dictionary (DList< DictItem > buckets[], unsigned int numBuckets, HashFunc hfunc=Cpl::Container::hashFuncDefault)
	Constructor. Note: Client provides the memory for the table.
Operations to manage items in the Dictionary
void	insert (ITEM &node)
	Inserts an item into the table.
ITEM *	remove (const Key &keyOfObjectToDelete)
	Removes the node (if it exists) that has the matching key.
bool	removeItem (ITEM &node)
	Removes the specified item from the table.
ITEM *	find (const Key &keyToFind) const
	Searches for a item with a matching key.
bool	isInDictionary (ITEM &node) const
	Returns true if the specified item is in the Dictionary; else false is returned.
ITEM *	first () const
	Returns the first item in the table. Returns 0 if table is empty.
ITEM *	next (ITEM &current) const
	Returns the next item in the table.
ITEM *	getFirst ()
	Removes the first item in the list.
Operations on the Dictionary itself
void	move (Dictionary< ITEM > &dst)
	Moves the content of the this Dictionary to the specified Dictionary.
void	clearTheDictionary ()
	Empties the Dictionary.
void	stats (HashTableStats &tableInfo) const
	Returns table stats.

Constructor & Destructor Documentation

Dictionary()

template<class ITEM >

Cpl::Container::Dictionary< ITEM >::Dictionary ( DList< DictItem >  buckets[], unsigned int  numBuckets, HashFunc  hfunc = Cpl::Container::hashFuncDefault  )

inline

Constructor. Note: Client provides the memory for the table.

Member Function Documentation

clearTheDictionary()

template<class ITEM >

void Cpl::Container::Dictionary< ITEM >::clearTheDictionary

(

)

Empties the Dictionary.

All references to the item(s) in the dictionary are lost.

find()

template<class ITEM >

ITEM * Cpl::Container::Dictionary< ITEM >::find

(

const Key &

keyToFind

)

const

Searches for a item with a matching key.

Returns the node that matches, else 0.

first()

template<class ITEM >

ITEM * Cpl::Container::Dictionary< ITEM >::first

(

)

const

Returns the first item in the table. Returns 0 if table is empty.

getFirst()

template<class ITEM >

ITEM * Cpl::Container::Dictionary< ITEM >::getFirst

(

)

Removes the first item in the list.

Returns 0 if the list is empty.

insert()

template<class ITEM >

void Cpl::Container::Dictionary< ITEM >::insert

(

ITEM &

node

)

Inserts an item into the table.

isInDictionary()

template<class ITEM >

bool Cpl::Container::Dictionary< ITEM >::isInDictionary

(

ITEM &

node

)

const

Returns true if the specified item is in the Dictionary; else false is returned.

move()

template<class ITEM >

void Cpl::Container::Dictionary< ITEM >::move

(

Dictionary< ITEM > &

dst

)

Moves the content of the this Dictionary to the specified Dictionary.

next()

template<class ITEM >

ITEM * Cpl::Container::Dictionary< ITEM >::next

(

ITEM &

current

)

const

Returns the next item in the table.

Returns 0 if at the end-of-table Note: There is NO ORDER of the items stored in the Dictionary!

remove()

template<class ITEM >

ITEM * Cpl::Container::Dictionary< ITEM >::remove

(

const Key &

keyOfObjectToDelete

)

Removes the node (if it exists) that has the matching key.

Returns the node removed from the table or 0 if no key match was found.

removeItem()

template<class ITEM >

bool Cpl::Container::Dictionary< ITEM >::removeItem

(

ITEM &

node

)

Removes the specified item from the table.

Returns true when the node was found and removed; else false is returned (i.e. node not exists in the table).

stats()

template<class ITEM >

void Cpl::Container::Dictionary< ITEM >::stats

(

HashTableStats &

tableInfo

)

const

Returns table stats.

Caller provides the memory for the stats structure.

Note: The stats are not calculate/gathered until this method is called. The duration of this call is directly related to the number of items in the dictionary.

---

The documentation for this class was generated from the following file:

• Cpl/Container/Dictionary.h