Teuchos - Trilinos Tools Package Version of the Day
Public Member Functions | Related Functions
Teuchos::Hashtable< Key, Value > Class Template Reference

Templated hashtable class. More...

#include <Teuchos_Hashtable.hpp>

List of all members.

Public Member Functions

 Hashtable (int capacity=101, double rehashDensity=0.8)
 Create an empty Hashtable.
bool containsKey (const Key &key) const
 Check for the presence of a key.
const Value & get (const Key &key) const
 Get the value indexed by key.
void put (const Key &key, const Value &value)
 Put a new (key, value) pair in the table.
void remove (const Key &key)
 Remove from the table the element given by key.
int size () const
 Get the number of elements in the table.
void arrayify (Array< Key > &keys, Array< Value > &values) const
 Get lists of keys and values in Array form.
double avgDegeneracy () const
 Return the average degeneracy (average number of entries per hash code).
double density () const
 Return the density of the hashtable (num entries / capacity)
void setRehashDensity (double rehashDensity)
 Set the density at which to do a rehash.
std::string toString () const
 Write to a std::string.

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.

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

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

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 153 of file Teuchos_Hashtable.hpp.

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 278 of file Teuchos_Hashtable.hpp.

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 172 of file Teuchos_Hashtable.hpp.

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 305 of file Teuchos_Hashtable.hpp.

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.

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 224 of file Teuchos_Hashtable.hpp.

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.

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.

template<class Key, class Value>
void Teuchos::Hashtable< Key, Value >::setRehashDensity ( double  rehashDensity) [inline]

Set the density at which to do a rehash.

template<class Key , class Value >
std::string Teuchos::Hashtable< Key, Value >::toString ( ) const [inline]

Write to a std::string.

Definition at line 240 of file Teuchos_Hashtable.hpp.


Friends And Related Function Documentation

template<class Key , class Value >
std::ostream & operator<< ( std::ostream &  os,
const Hashtable< Key, Value > &  h 
) [related]

Write Hashtable to a stream.

Definition at line 337 of file Teuchos_Hashtable.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines