COVISE Core: covise::coMultiHashBase< KEY, DATA > Class Template Reference

COVISE Core

#include <coMultiHashBase.h>

Inheritance diagram for covise::coMultiHashBase< KEY, DATA >:

Inheritance graph

[legend]

Public Member Functions
	coMultiHashBase ()
	constructor More...

	coMultiHashBase (DATA nullelem)
	constructor More...

const DATA &	getNullElem () const
	get the NULL element More...

virtual	~coMultiHashBase ()
	destructor More...

virtual int	insert (const KEY &key, const DATA &inData)
	insert an entry (virtual for non-multi hash) More...

int	remove (unsigned long hashIndex)
	remove an entry by hashIndex More...

void	removeAll ()
	remove an entry by hashIndex More...

unsigned long	getHash (const KEY &key) const
	get hash index, 0 if no element found More...

DATA &	operator[] (unsigned long hashIndex)
	access element by hash index: assert() correct index !! More...

const DATA &	operator[] (unsigned long hashIndex) const
	access element by hash index: assert() correct index !! More...

virtual unsigned long	nextHash (unsigned long hashIndex) const
	get next hashIndex to given hashIndex More...

int	getNumEntries () const
	get number of entries currently in hash More...

virtual unsigned long	hash1 (const KEY &) const =0
	first hash function (pure virtual) More...

virtual unsigned long	hash2 (const KEY &) const =0
	second hash function (pure virtual) More...

virtual bool	equal (const KEY &, const KEY &) const =0
	KEY1 == KEY2 operation (pure virtual) More...

Protected Types
enum	{ EMPTY = 0 , PREVIOUS , USED }

Protected Attributes
KEY *	keys

unsigned char *	entryFlags

unsigned int	size
	size of the list More...

unsigned int	prime
	the prime currently used as the length of the list More...

Private Types
enum	{ NUMPRIMES = 28 }

Private Member Functions
void	resize (void)

Private Attributes
DATA	d_nullElem

DATA *	data

unsigned int	entries

unsigned int	maxEntries

int	primeIndex

Friends
class	coHashIter< KEY, DATA >

class	coHashBase< KEY, DATA >

Detailed Description

template<class KEY, class DATA>
class covise::coMultiHashBase< KEY, DATA >

Virtual base class implementing the double-hashing algorithm.

Requires:

class KEY with default constructor + operator=
class DATA with default constructor + operator=

Users must derive a class and define:

virtual unsigned int hash1(const KEY &) 1st level hash fkt.
virtual unsigned int hash2(const KEY &) 2nd level hash fkt.
Lars Frenzel, Andreas Werner
Version
1.1
changes: getHash/nextHash/[] AW EntryFlags 3 values for remove() AW flag values, keys, and entry flags now protected: R.B.

Member Enumeration Documentation

◆ anonymous enum

template<class KEY , class DATA >

anonymous enum

private

Enumerator
NUMPRIMES

◆ anonymous enum

template<class KEY , class DATA >

anonymous enum

protected

Enumerator
EMPTY
PREVIOUS
USED

Constructor & Destructor Documentation

◆ coMultiHashBase() [1/2]

template<class KEY , class DATA >

covise::coMultiHashBase< KEY, DATA >::coMultiHashBase

inline

constructor

◆ coMultiHashBase() [2/2]

template<class KEY , class DATA >

covise::coMultiHashBase< KEY, DATA >::coMultiHashBase ( DATA nullelem )

inline

constructor

◆ ~coMultiHashBase()

template<class KEY , class DATA >

covise::coMultiHashBase< KEY, DATA >::~coMultiHashBase

inlinevirtual

destructor

Member Function Documentation

◆ equal()

template<class KEY , class DATA >

virtual bool covise::coMultiHashBase< KEY, DATA >::equal	(	const KEY &	,
		const KEY &
	)		const

pure virtual

KEY1 == KEY2 operation (pure virtual)

Implemented in covise::coHashBase< int, DATA >, covise::coIntHash< DATA >, covise::coIntMultiHash< DATA >, and covise::coHashBase< KEY, DATA >.

◆ getHash()

template<class KEY , class DATA >

unsigned long covise::coMultiHashBase< KEY, DATA >::getHash ( const KEY & key ) const

inline

get hash index, 0 if no element found

◆ getNullElem()

template<class KEY , class DATA >

const DATA & covise::coMultiHashBase< KEY, DATA >::getNullElem ( ) const

inline

get the NULL element

◆ getNumEntries()

template<class KEY , class DATA >

int covise::coMultiHashBase< KEY, DATA >::getNumEntries

inline

get number of entries currently in hash

◆ hash1()

template<class KEY , class DATA >

virtual unsigned long covise::coMultiHashBase< KEY, DATA >::hash1 ( const KEY & ) const

pure virtual

first hash function (pure virtual)

Implemented in covise::coHashBase< int, DATA >, covise::coIntHash< DATA >, covise::coIntMultiHash< DATA >, and covise::coHashBase< KEY, DATA >.

◆ hash2()

template<class KEY , class DATA >

virtual unsigned long covise::coMultiHashBase< KEY, DATA >::hash2 ( const KEY & ) const

pure virtual

second hash function (pure virtual)

Implemented in covise::coHashBase< int, DATA >, covise::coIntHash< DATA >, covise::coIntMultiHash< DATA >, and covise::coHashBase< KEY, DATA >.

◆ insert()

template<class KEY , class DATA >

int covise::coMultiHashBase< KEY, DATA >::insert	(	const KEY &	key,
		const DATA &	inData
	)

inlinevirtual

insert an entry (virtual for non-multi hash)

Reimplemented in covise::coHashBase< int, DATA >, covise::coMultiHash< int, DATA >, covise::coHash< KEY, DATA >, covise::coHashBase< KEY, DATA >, and covise::coMultiHash< KEY, DATA >.

◆ nextHash()

template<class KEY , class DATA >

unsigned long covise::coMultiHashBase< KEY, DATA >::nextHash ( unsigned long hashIndex ) const

inlinevirtual

get next hashIndex to given hashIndex

Reimplemented in covise::coHashBase< KEY, DATA >, and covise::coHashBase< int, DATA >.

◆ operator[]() [1/2]

template<class KEY , class DATA >

DATA & covise::coMultiHashBase< KEY, DATA >::operator[] ( unsigned long hashIndex )

inline

access element by hash index: assert() correct index !!

◆ operator[]() [2/2]

template<class KEY , class DATA >

const DATA & covise::coMultiHashBase< KEY, DATA >::operator[] ( unsigned long hashIndex ) const

inline

access element by hash index: assert() correct index !!

◆ remove()

template<class KEY , class DATA >

int covise::coMultiHashBase< KEY, DATA >::remove ( unsigned long hashIndex )

inline

remove an entry by hashIndex

◆ removeAll()

template<class KEY , class DATA >

void covise::coMultiHashBase< KEY, DATA >::removeAll

inline

remove an entry by hashIndex

◆ resize()

template<class KEY , class DATA >

void covise::coMultiHashBase< KEY, DATA >::resize ( void )

inlineprivate

Friends And Related Function Documentation

◆ coHashBase< KEY, DATA >

template<class KEY , class DATA >

friend class coHashBase< KEY, DATA >

friend

◆ coHashIter< KEY, DATA >

template<class KEY , class DATA >

friend class coHashIter< KEY, DATA >

friend

Member Data Documentation

◆ d_nullElem

template<class KEY , class DATA >

DATA covise::coMultiHashBase< KEY, DATA >::d_nullElem

private

◆ data

template<class KEY , class DATA >

DATA* covise::coMultiHashBase< KEY, DATA >::data

private

◆ entries

template<class KEY , class DATA >

unsigned int covise::coMultiHashBase< KEY, DATA >::entries

private

◆ entryFlags

template<class KEY , class DATA >

unsigned char* covise::coMultiHashBase< KEY, DATA >::entryFlags

protected

◆ keys

template<class KEY , class DATA >

KEY* covise::coMultiHashBase< KEY, DATA >::keys

protected

◆ maxEntries

template<class KEY , class DATA >

unsigned int covise::coMultiHashBase< KEY, DATA >::maxEntries

private

◆ prime

template<class KEY , class DATA >

unsigned int covise::coMultiHashBase< KEY, DATA >::prime

protected

the prime currently used as the length of the list

◆ primeIndex

template<class KEY , class DATA >

int covise::coMultiHashBase< KEY, DATA >::primeIndex

private

◆ size

template<class KEY , class DATA >

unsigned int covise::coMultiHashBase< KEY, DATA >::size

protected

size of the list

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

util/coIntMultiHash.h
util/coMultiHashBase.h