Cpl::Container::HashTable_ Class Reference

This concrete provides a collection of functions used by the 'Hash Table' classes. More...

Detailed Description

This concrete provides a collection of functions used by the 'Hash Table' classes.

This class is not intended to be used directly by clients.

Key collisions are handled by a simple link list for each 'hash bucket'.

NOTE: 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 or removed from the table.

#include <HashTable_.h>

Static Public Member Functions
static void	insert (DictItem &node, DList< DictItem > *buckets, unsigned int numBuckets, HashFunc hashFunc, unsigned long &numItems) noexcept
	Inserts an item into the table.
static DictItem *	removeItem (DictItem &nodeToDelete, DList< DictItem > *buckets, unsigned int numBuckets, HashFunc hashFunc, unsigned long &numItems) noexcept
	Removes the specified item from the table.
static DictItem *	find (const Key &keyToFind, DList< DictItem > *buckets, unsigned int numBuckets, HashFunc hashFunc) noexcept
	Searches for a item with a matching key.
static DictItem *	first (DList< DictItem > *buckets, unsigned int numBuckets, HashFunc hashFunc, unsigned long numItems) noexcept
	Returns the first item in the table. Returns 0 if table is empty.
static DictItem *	next (DictItem &current, DList< DictItem > *buckets, unsigned int numBuckets, HashFunc hashFunc) noexcept
	Returns the next item in the table. Returns 0 if at the end-of-table.
static void	tableStats (HashTableStats &tableInfo, DList< DictItem > *buckets, unsigned int numBuckets, HashFunc hashFunc, unsigned long numItems) noexcept
	Returns table stats.

Member Function Documentation

find()

static DictItem * Cpl::Container::HashTable_::find ( const Key &  keyToFind, DList< DictItem > *  buckets, unsigned int  numBuckets, HashFunc  hashFunc  )

staticnoexcept

Searches for a item with a matching key.

Returns the node that matches, else 0.

first()

static DictItem * Cpl::Container::HashTable_::first ( DList< DictItem > *  buckets, unsigned int  numBuckets, HashFunc  hashFunc, unsigned long  numItems  )

staticnoexcept

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

insert()

static void Cpl::Container::HashTable_::insert ( DictItem &  node, DList< DictItem > *  buckets, unsigned int  numBuckets, HashFunc  hashFunc, unsigned long &  numItems  )

staticnoexcept

Inserts an item into the table.

next()

static DictItem * Cpl::Container::HashTable_::next ( DictItem &  current, DList< DictItem > *  buckets, unsigned int  numBuckets, HashFunc  hashFunc  )

staticnoexcept

Returns the next item in the table. Returns 0 if at the end-of-table.

removeItem()

static DictItem * Cpl::Container::HashTable_::removeItem ( DictItem &  nodeToDelete, DList< DictItem > *  buckets, unsigned int  numBuckets, HashFunc  hashFunc, unsigned long &  numItems  )

staticnoexcept

Removes the specified item from the table.

Returns the node removed. If the remove fails (i.e. node does not exist in the table), then 0 is returned.

tableStats()

static void Cpl::Container::HashTable_::tableStats ( HashTableStats &  tableInfo, DList< DictItem > *  buckets, unsigned int  numBuckets, HashFunc  hashFunc, unsigned long  numItems  )

staticnoexcept

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 hash table.

---

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

• Cpl/Container/HashTable_.h