Templated hashtable class. More...

#include <Teuchos_Hashtable.hpp>

Public Member Functions
	Hashtable (int capacity=101, double rehashDensity=0.8)
	Create an empty Hashtable. More...

bool	containsKey (const Key &key) const
	Check for the presence of a key. More...

const Value &	get (const Key &key) const
	Get the value indexed by key. More...

void	put (const Key &key, const Value &value)
	Put a new (key, value) pair in the table. More...

void	remove (const Key &key)
	Remove from the table the element given by key. More...

int	size () const
	Get the number of elements in the table. More...

void	arrayify (Array< Key > &keys, Array< Value > &values) const
	Get lists of keys and values in Array form. More...

double	avgDegeneracy () const
	Return the average degeneracy (average number of entries per hash code). More...

double	density () const
	Return the density of the hashtable (num entries / capacity) More...

void	setRehashDensity (double rehashDensity)
	Set the density at which to do a rehash. More...

std::string	toString () const
	Write to a std::string. More...

Private Member Functions
void	rehash ()

int	nextPrime (int newCap) const

void	accumulateAvgFill (int n) const

Private Attributes
Array< Array< HashPair< Key, Value > > >	data_

int	count_

int	capacity_

Value	mostRecentValue_

Key	mostRecentKey_

size_t	nHits_

double	avgDegeneracy_

double	rehashDensity_

Related Functions
(Note that these are not member functions.)
template<class Key , class Value >
std::ostream &	operator<< (std::ostream &os, const Hashtable< Key, Value > &h)
	Write Hashtable to a stream. More...

Detailed Description

template<class Key, class Value>
class Teuchos::Hashtable< Key, Value >

Templated hashtable class.

Author: Kevin Long

Definition at line 80 of file Teuchos_Hashtable.hpp.

Constructor & Destructor Documentation

◆ Hashtable()

template<class Key , class Value >

Teuchos::Hashtable< Key, Value >::Hashtable	(	int	capacity = `101`,
		double	rehashDensity = `0.8`
	)

inline

Create an empty Hashtable.

Definition at line 145 of file Teuchos_Hashtable.hpp.

Member Function Documentation

◆ containsKey()

template<class Key , class Value >

bool Teuchos::Hashtable< Key, Value >::containsKey ( const Key & key ) const

inline

Check for the presence of a key.

Definition at line 157 of file Teuchos_Hashtable.hpp.

◆ get()

template<class Key , class Value >

const Value & Teuchos::Hashtable< Key, Value >::get ( const Key & key ) const

inline

Get the value indexed by key.

Definition at line 282 of file Teuchos_Hashtable.hpp.

◆ put()

template<class Key , class Value >

void Teuchos::Hashtable< Key, Value >::put	(	const Key &	key,
		const Value &	value
	)

inline

Put a new (key, value) pair in the table.

Definition at line 176 of file Teuchos_Hashtable.hpp.

◆ remove()

template<class Key , class Value >

void Teuchos::Hashtable< Key, Value >::remove ( const Key & key )

inline

Remove from the table the element given by key.

Definition at line 309 of file Teuchos_Hashtable.hpp.

◆ size()

template<class Key, class Value>

int Teuchos::Hashtable< Key, Value >::size ( ) const

inline

Get the number of elements in the table.

Definition at line 100 of file Teuchos_Hashtable.hpp.

◆ arrayify()

template<class Key , class Value >

void Teuchos::Hashtable< Key, Value >::arrayify	(	Array< Key > &	keys,
		Array< Value > &	values
	)		const

inline

Get lists of keys and values in Array form.

Definition at line 228 of file Teuchos_Hashtable.hpp.

◆ avgDegeneracy()

template<class Key, class Value>

double Teuchos::Hashtable< Key, Value >::avgDegeneracy ( ) const

inline

Return the average degeneracy (average number of entries per hash code).

Definition at line 106 of file Teuchos_Hashtable.hpp.

◆ density()

template<class Key, class Value>

double Teuchos::Hashtable< Key, Value >::density ( ) const

inline

Return the density of the hashtable (num entries / capacity)

Definition at line 109 of file Teuchos_Hashtable.hpp.

◆ setRehashDensity()

template<class Key, class Value>

void Teuchos::Hashtable< Key, Value >::setRehashDensity ( double rehashDensity )

inline

Set the density at which to do a rehash.

◆ toString()

template<class Key , class Value >

std::string Teuchos::Hashtable< Key, Value >::toString ( ) const

inline

Write to a std::string.

Definition at line 244 of file Teuchos_Hashtable.hpp.

◆ rehash()

template<class Key , class Value >

void Teuchos::Hashtable< Key, Value >::rehash ( )

inlineprivate

Definition at line 210 of file Teuchos_Hashtable.hpp.

◆ nextPrime()

template<class Key, class Value>

int Teuchos::Hashtable< Key, Value >::nextPrime ( int newCap ) const

inlineprivate

◆ accumulateAvgFill()

template<class Key , class Value >

void Teuchos::Hashtable< Key, Value >::accumulateAvgFill ( int n ) const

inlineprivate

Definition at line 334 of file Teuchos_Hashtable.hpp.

Friends And Related Function Documentation

◆ operator<<()

template<class Key , class Value >

std::ostream & operator<<	(	std::ostream &	os,
		const Hashtable< Key, Value > &	h
	)

Definition at line 341 of file Teuchos_Hashtable.hpp.

Member Data Documentation

◆ data_

template<class Key, class Value>

Array<Array<HashPair<Key, Value> > > Teuchos::Hashtable< Key, Value >::data_

private

Definition at line 124 of file Teuchos_Hashtable.hpp.

◆ count_

template<class Key, class Value>

int Teuchos::Hashtable< Key, Value >::count_

private

Definition at line 125 of file Teuchos_Hashtable.hpp.

◆ capacity_

template<class Key, class Value>

int Teuchos::Hashtable< Key, Value >::capacity_

private

Definition at line 126 of file Teuchos_Hashtable.hpp.

◆ mostRecentValue_

template<class Key, class Value>

Value Teuchos::Hashtable< Key, Value >::mostRecentValue_

mutableprivate

Definition at line 127 of file Teuchos_Hashtable.hpp.

◆ mostRecentKey_

template<class Key, class Value>

Key Teuchos::Hashtable< Key, Value >::mostRecentKey_

mutableprivate

Definition at line 128 of file Teuchos_Hashtable.hpp.

◆ nHits_

template<class Key, class Value>

size_t Teuchos::Hashtable< Key, Value >::nHits_

mutableprivate

Definition at line 130 of file Teuchos_Hashtable.hpp.

◆ avgDegeneracy_

template<class Key, class Value>

double Teuchos::Hashtable< Key, Value >::avgDegeneracy_

mutableprivate

Definition at line 131 of file Teuchos_Hashtable.hpp.

◆ rehashDensity_

template<class Key, class Value>

double Teuchos::Hashtable< Key, Value >::rehashDensity_

private

Definition at line 132 of file Teuchos_Hashtable.hpp.

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

Teuchos_Hashtable.hpp

Public Member Functions

Private Member Functions

Private Attributes

Related Functions

Detailed Description

template<class Key, class Value> class Teuchos::Hashtable< Key, Value >

Constructor & Destructor Documentation

◆ Hashtable()

Member Function Documentation

◆ containsKey()

◆ get()

◆ put()

◆ remove()

◆ size()

◆ arrayify()

◆ avgDegeneracy()

◆ density()

◆ setRehashDensity()

◆ toString()

◆ rehash()

◆ nextPrime()

◆ accumulateAvgFill()

Friends And Related Function Documentation

◆ operator<<()

Member Data Documentation

◆ data_

◆ count_

◆ capacity_

◆ mostRecentValue_

◆ mostRecentKey_

◆ nHits_

◆ avgDegeneracy_

◆ rehashDensity_

template<class Key, class Value>
class Teuchos::Hashtable< Key, Value >