HashPtrTable< T, Key, Hash > Class Template Reference

A HashTable specialization for hashing pointers. More...

Inheritance diagram for HashPtrTable< T, Key, Hash >:
Collaboration diagram for HashPtrTable< T, Key, Hash >:

Public Types

typedef HashTable< T *, Key,
Hash >::iterator 
iterator
 
typedef HashTable< T *, Key,
Hash >::const_iterator 
const_iterator
 
- Public Types inherited from HashTable< T *, Key, Hash >
typedef Tvalue_type
 Type of values the HashTable contains. More...
 
typedef T *& reference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const T *& const_reference
 Type that can be used for storing into constant. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 

Public Member Functions

 HashPtrTable (const label size=128)
 Construct given initial table size. More...
 
template<class INew >
 HashPtrTable (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 HashPtrTable (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
 HashPtrTable (const dictionary &)
 Construct from dictionary using default dictionary constructor. More...
 
 HashPtrTable (const HashPtrTable< T, Key, Hash > &)
 Construct as copy. More...
 
 ~HashPtrTable ()
 Destructor. More...
 
Tremove (iterator &)
 Remove and return the pointer specified by given iterator. More...
 
bool erase (iterator &)
 Erase an hashedEntry specified by given iterator. More...
 
void clear ()
 Clear all entries from table. More...
 
void write (Ostream &os) const
 Write. More...
 
void operator= (const HashPtrTable< T, Key, Hash > &)
 
- Public Member Functions inherited from HashTable< T *, Key, Hash >
bool set (const Key &, const T *&newElmt)
 Assign a new hashedEntry, overwriting existing entries. More...
 
 HashTable (const label size=128)
 Construct given initial table size. More...
 
 HashTable (Istream &, const label size=128)
 Construct from Istream. More...
 
 HashTable (const HashTable< T *, Key, Hash > &)
 Construct as copy. More...
 
 HashTable (const Xfer< HashTable< T *, Key, Hash > > &)
 Construct by transferring the parameter contents. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const
 The size of the underlying table. More...
 
label size () const
 Return number of elements in table. More...
 
bool empty () const
 Return true if the hash table is empty. More...
 
bool found (const Key &) const
 Return true if hashedEntry is found in table. More...
 
iterator find (const Key &)
 Find and return an iterator set at the hashedEntry. More...
 
const_iterator find (const Key &) const
 Find and return an const_iterator set at the hashedEntry. More...
 
List< Key > toc () const
 Return the table of contents. More...
 
List< Key > sortedToc () const
 Return the table of contents as a sorted list. More...
 
OstreamprintInfo (Ostream &) const
 Print information. More...
 
bool insert (const Key &, const T *&newElmt)
 Insert a new hashedEntry. More...
 
bool erase (const iterator &)
 Erase a hashedEntry specified by given iterator. More...
 
bool erase (const Key &)
 Erase a hashedEntry specified by the given key. More...
 
label erase (const UList< Key > &)
 Remove entries given by the listed keys from this HashTable. More...
 
label erase (const HashTable< AnyType, Key, AnyHash > &)
 Remove entries given by the given keys from this HashTable. More...
 
void resize (const label newSize)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void shrink ()
 Shrink the allocated table to approx. twice number of elements. More...
 
void transfer (HashTable< T *, Key, Hash > &)
 Transfer the contents of the argument table into this table. More...
 
Xfer< HashTable< T *, Key, Hash > > xfer ()
 Transfer contents to the Xfer container. More...
 
T *& operator[] (const Key &)
 Find and return a hashedEntry. More...
 
const T *& operator[] (const Key &) const
 Find and return a hashedEntry. More...
 
T *& operator() (const Key &)
 Find and return a hashedEntry, create it null if not present. More...
 
void operator= (const HashTable< T *, Key, Hash > &)
 Assignment. More...
 
bool operator== (const HashTable< T *, Key, Hash > &) const
 Equality. Hash tables are equal if the keys and values are equal. More...
 
bool operator!= (const HashTable< T *, Key, Hash > &) const
 The opposite of the equality operation. Takes linear time. More...
 
iterator begin ()
 iterator set to the beginning of the HashTable More...
 
const_iterator begin () const
 const_iterator set to the beginning of the HashTable More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable More...
 
- Public Member Functions inherited from HashTableCore
 HashTableCore ()
 Construct null. More...
 
 ClassName ("HashTable")
 Define template name and debug. More...
 

Friends

Istreamoperator>> (Istream &, HashPtrTable< T, Key, Hash > &)
 
Ostreamoperator (Ostream &, const HashPtrTable< T, Key, Hash > &)
 

Additional Inherited Members

- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label)
 Return a canonical (power-of-two) size. More...
 
static iteratorEnd cend ()
 iteratorEnd set to beyond the end of any HashTable More...
 
static iteratorEnd end ()
 iteratorEnd set to beyond the end of any HashTable More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. More...
 

Detailed Description

template<class T, class Key, class Hash>
class Foam::HashPtrTable< T, Key, Hash >

A HashTable specialization for hashing pointers.

Source files

Definition at line 50 of file HashPtrTable.H.

Member Typedef Documentation

typedef HashTable<T*, Key, Hash>::iterator iterator

Definition at line 82 of file HashPtrTable.H.

Definition at line 83 of file HashPtrTable.H.

Constructor & Destructor Documentation

HashPtrTable ( const label  size = 128)

Construct given initial table size.

Definition at line 33 of file HashPtrTable.C.

HashPtrTable ( Istream is,
const INew inewt 
)

Construct from Istream using given Istream constructor class.

Definition at line 182 of file HashPtrTableIO.C.

HashPtrTable ( Istream is)

Construct from Istream using default Istream constructor class.

Definition at line 189 of file HashPtrTableIO.C.

HashPtrTable ( const dictionary dict)

Construct from dictionary using default dictionary constructor.

class

Definition at line 196 of file HashPtrTableIO.C.

HashPtrTable ( const HashPtrTable< T, Key, Hash > &  ht)

Construct as copy.

Definition at line 42 of file HashPtrTable.C.

References HashTable< T *, Key, Hash >::begin(), HashTableCore::end(), insert(), and Foam::T().

Here is the call graph for this function:

Destructor.

Definition at line 58 of file HashPtrTable.C.

References clear().

Here is the call graph for this function:

Member Function Documentation

T * remove ( iterator it)

Remove and return the pointer specified by given iterator.

Definition at line 67 of file HashPtrTable.C.

References HashTable< T, Key, Hash >::erase(), and Foam::T().

Here is the call graph for this function:

bool erase ( iterator it)

Erase an hashedEntry specified by given iterator.

Definition at line 76 of file HashPtrTable.C.

References Foam::T().

Here is the call graph for this function:

void clear ( )

Clear all entries from table.

Definition at line 97 of file HashPtrTable.C.

References HashTable< T, Key, Hash >::clear().

Here is the call graph for this function:

void write ( Ostream os) const

Write.

Definition at line 161 of file HashPtrTableIO.C.

References T.

void operator= ( const HashPtrTable< T, Key, Hash > &  rhs)

Definition at line 117 of file HashPtrTable.C.

References Foam::abort(), clear(), Foam::FatalError, FatalErrorIn, insert(), and Foam::T().

Here is the call graph for this function:

Friends And Related Function Documentation

Istream& operator>> ( Istream ,
HashPtrTable< T, Key, Hash > &   
)
friend
Ostream& operator ( Ostream ,
const HashPtrTable< T, Key, Hash > &   
)
friend

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