FreeFOAM The Cross-Platform CFD Toolkit
Map< T > Class Template Reference

A HashTable to objects of type <T> with a label key. More...

#include <OpenFOAM/Map.H>


Detailed Description

template<class T>
class Foam::Map< T >

A HashTable to objects of type <T> with a label key.

See also:
PtrMap

Definition at line 50 of file Map.H.

+ Inheritance diagram for Map< T >:
+ Collaboration diagram for Map< T >:

List of all members.

Public Types

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

Public Member Functions

 Map (const label size=128)
 Construct given initial size.
 Map (Istream &is)
 Construct from Istream.
 Map (const Map< T > &map)
 Construct as copy.
 Map (const Xfer< Map< T > > &map)
 Construct by transferring the parameter contents.
 Map (const Xfer< HashTable< T, label, Hash< label > > > &map)
 Construct by transferring the parameter contents.
- Public Member Functions inherited from HashTable< T, label, Hash< label > >
bool set (const label &, const T &newElmt)
 Assign a new hashedEntry, overwriting existing entries.
 HashTable (const label size=128)
 Construct given initial table size.
 HashTable (Istream &, const label size=128)
 Construct from Istream.
 HashTable (const HashTable< T, label, Hash< label > > &)
 Construct as copy.
 HashTable (const Xfer< HashTable< T, label, Hash< label > > > &)
 Construct by transferring the parameter contents.
 ~HashTable ()
label size () const
 Return number of elements in table.
bool empty () const
 Return true if the hash table is empty.
bool found (const label &) const
 Return true if hashedEntry is found in table.
iterator find (const label &)
 Find and return an iterator set at the hashedEntry.
const_iterator find (const label &) const
 Find and return an const_iterator set at the hashedEntry.
List< label > toc () const
 Return the table of contents.
List< label > sortedToc () const
 Return the table of contents as a sorted list.
OstreamprintInfo (Ostream &) const
 Print information.
bool insert (const label &, const T &newElmt)
 Insert a new hashedEntry.
bool erase (const iterator &)
 Erase an hashedEntry specified by given iterator.
bool erase (const label &)
 Erase an hashedEntry specified by given key if in table.
label erase (const UList< label > &)
 Remove entries given by the listed keys from this HashTable.
label erase (const HashTable< AnyType, label, AnyHash > &)
 Remove entries given by the given keys from this HashTable.
void resize (const label newSize)
 Resize the hash table for efficiency.
void clear ()
 Clear all entries from table.
void clearStorage ()
 Clear the table entries and the table itself.
void transfer (HashTable< T, label, Hash< label > > &)
 Transfer the contents of the argument table into this table.
Xfer< HashTable< T, label,
Hash< label > > > 
xfer ()
 Transfer contents to the Xfer container.
Toperator[] (const label &)
 Find and return an hashedEntry.
const Toperator[] (const label &) const
 Find and return an hashedEntry.
Toperator() (const label &)
 Find and return an hashedEntry, create it null if not present.
void operator= (const HashTable< T, label, Hash< label > > &)
 Assignment.
bool operator== (const HashTable< T, label, Hash< label > > &) const
 Equality. Two hash tables are equal if all contents of first are.
bool operator!= (const HashTable< T, label, Hash< label > > &) const
 The opposite of the equality operation. Takes linear time.
iterator begin ()
 iterator set to the begining of the HashTable
const_iterator begin () const
 const_iterator set to the beginning of the HashTable
const iterator & end ()
 iterator set to beyond the end of the HashTable
const const_iterator & end () const
 const_iterator set to beyond the end of the HashTable
const_iterator cbegin () const
 const_iterator set to the beginning of the HashTable
const const_iterator & cend () const
 const_iterator set to beyond the end of the HashTable

Member Typedef Documentation

typedef HashTable<T, label, Hash<label> >::iterator iterator

Reimplemented from HashTable< T, label, Hash< label > >.

Definition at line 57 of file Map.H.

typedef HashTable<T, label, Hash<label> >::const_iterator const_iterator

Reimplemented from HashTable< T, label, Hash< label > >.

Definition at line 60 of file Map.H.


Constructor & Destructor Documentation

Map ( const label  size = 128)
inline

Construct given initial size.

Definition at line 65 of file Map.H.

Map ( Istream is)
inline

Construct from Istream.

Definition at line 71 of file Map.H.

Map ( const Map< T > &  map)
inline

Construct as copy.

Definition at line 77 of file Map.H.

Map ( const Xfer< Map< T > > &  map)
inline

Construct by transferring the parameter contents.

Definition at line 83 of file Map.H.

Map ( const Xfer< HashTable< T, label, Hash< label > > > &  map)
inline

Construct by transferring the parameter contents.

Definition at line 89 of file Map.H.


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