Map< T > Class Template Reference

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

Inheritance diagram for Map< T >:
[legend]
Collaboration diagram for Map< T >:
[legend]

Public Types

typedef Map< Tthis_type
 The template instance used for this Map. More...
 
typedef HashTable< T, label, Hash< label > > parent_type
 The template instance used for the parent HashTable. More...
 
using iterator = typename parent_type::iterator
 
using const_iterator = typename parent_type::const_iterator
 
- Public Types inherited from HashTable< T, label, Hash< label > >
typedef HashTable< T, label, Hash< label > > this_type
 The template instance used for this HashTable. More...
 
typedef std::conditional< std::is_same< zero::null, typenamestd::remove_cv< T >::type >::value, Detail::HashTableSingle< label >, Detail::HashTablePair< label, T > >::type node_type
 
typedef label key_type
 The second template parameter, type of keys used. More...
 
typedef T mapped_type
 The first template parameter, type of objects contained. More...
 
typedef T value_type
 Same as mapped_type for OpenFOAM HashTables. More...
 
typedef Hash< label > hasher
 The third template parameter, the hash index method. More...
 
typedef Tpointer
 Pointer type for storing into value_type objects. More...
 
typedef Treference
 Reference to the stored value_type. More...
 
typedef const Tconst_pointer
 Const pointer type for the stored value_type. More...
 
typedef const Tconst_reference
 Const reference to the stored value_type. More...
 
typedef label difference_type
 The type to represent the difference between two iterators. More...
 
typedef label size_type
 The type that can represent the size of a HashTable. More...
 
using key_iterator = key_iterator_base< iterator >
 Forward iterator returning the key. More...
 
using const_key_iterator = key_iterator_base< const_iterator >
 Forward const iterator returning the key. More...
 

Public Member Functions

 Map ()
 Default construct with default table capacity. More...
 
 Map (const label size)
 Construct with given initial table capacity. More...
 
 Map (Istream &is)
 Construct from Istream with default table capacity. More...
 
 Map (const this_type &map)
 Copy construct. More...
 
 Map (this_type &&map)
 Move construct. More...
 
 Map (std::initializer_list< std::pair< label, T > > map)
 Construct from an initializer list. More...
 
void operator= (const this_type &rhs)
 Copy assignment. More...
 
void operator= (this_type &&rhs)
 Move assignment. More...
 
- Public Member Functions inherited from HashTable< T, label, Hash< label > >
 HashTable ()
 Default construct with default (128) table capacity. More...
 
 HashTable (const label size)
 Construct given initial table capacity. More...
 
 HashTable (Istream &is, const label size=128)
 Construct from Istream with default table capacity. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs)
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< label, T > > list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const noexcept
 The size of the underlying table. More...
 
label size () const noexcept
 The number of elements in table. More...
 
bool empty () const noexcept
 True if the hash table is empty. More...
 
Tat (const label &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const Tat (const label &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
bool found (const label &key) const
 Return true if hashed entry is found in table. More...
 
iterator find (const label &key)
 Find and return an iterator set at the hashed entry. More...
 
const_iterator find (const label &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const_iterator cfind (const label &key) const
 Find and return an const_iterator set at the hashed entry. More...
 
const Tlookup (const label &key, const T &deflt) const
 Return hashed entry if it exists, or return the given default. More...
 
List< label > toc () const
 The table of contents (the keys) in unsorted order. More...
 
List< label > sortedToc () const
 The table of contents (the keys) in sorted order. More...
 
List< label > sortedToc (const Compare &comp) const
 
Foam::List< label > sortedToc (const Compare &comp) const
 
List< label > tocKeys (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< label > tocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< label > tocValues (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< label > tocValues (const UnaryPredicate &pred, const bool invert) const
 
List< label > tocEntries (const BinaryPredicate &pred, const bool invert=false) const
 
Foam::List< label > tocEntries (const BinaryPredicate &pred, const bool invert) const
 
UPtrList< const node_typecsorted () const
 
UPtrList< const node_typesorted () const
 
UPtrList< node_typesorted ()
 
label countKeys (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of keys that satisfy the unary predicate. More...
 
Foam::label countKeys (const UnaryPredicate &pred, const bool invert) const
 
label countValues (const UnaryPredicate &pred, const bool invert=false) const
 Count the number of values that satisfy the unary predicate. More...
 
Foam::label countValues (const UnaryPredicate &pred, const bool invert) const
 
label countEntries (const BinaryPredicate &pred, const bool invert=false) const
 Count the number of entries that satisfy the binary predicate. More...
 
Foam::label countEntries (const BinaryPredicate &pred, const bool invert) const
 
bool emplace (const label &key, Args &&... args)
 Emplace insert a new entry, not overwriting existing entries. More...
 
bool emplace_set (const label &key, Args &&... args)
 Emplace set an entry, overwriting any existing entries. More...
 
bool insert (const label &key, const T &obj)
 Copy insert a new entry, not overwriting existing entries. More...
 
bool insert (const label &key, T &&obj)
 Move insert a new entry, not overwriting existing entries. More...
 
bool set (const label &key, const T &obj)
 Copy assign a new entry, overwriting existing entries. More...
 
bool set (const label &key, T &&obj)
 Move assign a new entry, overwriting existing entries. More...
 
bool erase (const iterator &iter)
 Erase an entry specified by given iterator. More...
 
bool erase (const label &key)
 Erase an entry specified by the given key. More...
 
label erase (const HashTable< AnyType, label, AnyHash > &other)
 Remove table entries given by keys of the other hash-table. More...
 
label erase (std::initializer_list< label > keys)
 Remove table entries given by the listed keys. More...
 
label erase (InputIter first, InputIter last)
 Remove multiple entries using an iterator range of keys. More...
 
label erase (const FixedList< label, N > &keys)
 Remove table entries given by the listed keys. More...
 
label erase (const UList< label > &keys)
 Remove table entries given by the listed keys. More...
 
Foam::label erase (InputIter first, InputIter last)
 
Foam::label erase (const FixedList< label, N > &keys)
 
Foam::label erase (const HashTable< AnyType, label, AnyHash > &other)
 
label retain (const HashTable< AnyType, label, AnyHash > &other)
 Retain table entries given by keys of the other hash-table. More...
 
Foam::label retain (const HashTable< AnyType, label, AnyHash > &other)
 
label filterKeys (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their keys. More...
 
Foam::label filterKeys (const UnaryPredicate &pred, const bool pruning)
 
label filterValues (const UnaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their values. More...
 
Foam::label filterValues (const UnaryPredicate &pred, const bool pruning)
 
label filterEntries (const BinaryPredicate &pred, const bool pruning=false)
 Generalized means to filter table entries based on their key/value. More...
 
Foam::label filterEntries (const BinaryPredicate &pred, const bool pruning)
 
void resize (const label sz)
 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 swap (HashTable< T, label, Hash< label > > &rhs)
 Swap contents into this table. More...
 
void transfer (HashTable< T, label, Hash< label > > &rhs)
 Transfer contents into this table. More...
 
Toperator[] (const label &key)
 Find and return a hashed entry. FatalError if it does not exist. More...
 
const Toperator[] (const label &key) const
 Find and return a hashed entry. FatalError if it does not exist. More...
 
Toperator() (const label &key)
 Return existing entry or create a new entry. More...
 
Toperator() (const label &key, const T &deflt)
 Return existing entry or insert a new entry. More...
 
void operator= (const this_type &rhs)
 Copy assign. More...
 
void operator= (std::initializer_list< std::pair< label, T > > rhs)
 Copy assign from an initializer list. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 
bool operator== (const this_type &rhs) const
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries into this HashTable. More...
 
const_iterator_pair< const_key_iterator, this_typekeys () const
 A const iterator begin/end pair for iterating over keys. 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...
 
iterator end () noexcept
 iterator to signal the end (for any HashTable) More...
 
const_iterator end () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
constexpr const_iterator cend () const noexcept
 const_iterator to signal the end (for any HashTable) More...
 
OstreamprintInfo (Ostream &os) const
 Print information. More...
 
OstreamwriteKeys (Ostream &os, const label shortLen=0) const
 
- Public Member Functions inherited from HashTableCore
 ClassName ("HashTable")
 Declare type-name (with debug switch) More...
 
 HashTableCore ()=default
 Default construct. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from HashTableCore
static label canonicalSize (const label requested_size)
 Return a canonical (power-of-two) of the requested size. More...
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable internal table size. Approximately labelMax/4. More...
 
- Protected Member Functions inherited from HashTable< T, label, Hash< label > >
bool iterator_erase (node_type *&entry, label &index)
 Low-level entry erasure using iterator internals. More...
 

Detailed Description

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

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

Note
The Map contents are unordered. When the key order is important, use the sortedToc() method to obtain a list of sorted keys and use that for further access.
See also
PtrMap

Definition at line 57 of file Map.H.

Member Typedef Documentation

◆ this_type

typedef Map<T> this_type

The template instance used for this Map.

Definition at line 64 of file Map.H.

◆ parent_type

typedef HashTable<T, label, Hash<label> > parent_type

The template instance used for the parent HashTable.

Definition at line 67 of file Map.H.

◆ iterator

using iterator = typename parent_type::iterator

Definition at line 69 of file Map.H.

◆ const_iterator

Definition at line 70 of file Map.H.

Constructor & Destructor Documentation

◆ Map() [1/6]

Map ( )
inline

Default construct with default table capacity.

Definition at line 76 of file Map.H.

◆ Map() [2/6]

Map ( const label  size)
inlineexplicit

Construct with given initial table capacity.

Definition at line 82 of file Map.H.

◆ Map() [3/6]

Map ( Istream is)
inline

Construct from Istream with default table capacity.

Definition at line 88 of file Map.H.

◆ Map() [4/6]

Map ( const this_type map)
inline

Copy construct.

Definition at line 94 of file Map.H.

◆ Map() [5/6]

Map ( this_type &&  map)
inline

Move construct.

Definition at line 100 of file Map.H.

◆ Map() [6/6]

Map ( std::initializer_list< std::pair< label, T > >  map)
inline

Construct from an initializer list.

Definition at line 106 of file Map.H.

Member Function Documentation

◆ operator=() [1/2]

void operator= ( const this_type rhs)
inline

Copy assignment.

Definition at line 117 of file Map.H.

References HashTable< T, label, Hash< label > >::operator=().

Referenced by IOMap< T >::IOMap(), boundaryRegion::operator=(), cellTable::operator=(), distribution::operator=(), and IOMap< T >::operator=().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=() [2/2]

void operator= ( this_type &&  rhs)
inline

Move assignment.

Definition at line 123 of file Map.H.

References HashTable< T, label, Hash< label > >::operator=().

Here is the call graph for this function:

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