A HashTable of pointers to objects of type <T>, with deallocation management of the pointers. More...


Public Types | |
| typedef HashPtrTable< T, Key, Hash > | this_type |
| The template instance used for this table. More... | |
| typedef HashTable< T *, Key, Hash > | 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 *, Key, Hash > | |
| typedef HashTable< T *, Key, Hash > | this_type |
| The template instance used for this HashTable. More... | |
| using | node_type = std::conditional_t< std::is_same_v< Foam::zero, std::remove_cv_t< T * > >, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T * > > |
| A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More... | |
| typedef Key | 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 | hasher |
| The third template parameter, the hash index method. More... | |
| typedef T * * | pointer |
| Pointer type for storing into value_type objects. More... | |
| typedef T * & | reference |
| Reference to the stored value_type. More... | |
| typedef const T * * | const_pointer |
| Const pointer type for the stored value_type. More... | |
| typedef const T * & | const_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 | |
| constexpr | HashPtrTable () noexcept=default |
| Default construct: empty without allocation (capacity=0) More... | |
| constexpr | HashPtrTable (Foam::zero) noexcept |
| Construct empty without allocation (capacity=0) More... | |
| HashPtrTable (const label initialCapacity) | |
| Construct given initial table capacity. More... | |
| HashPtrTable (const this_type &rhs) | |
| Copy construct, making a copy of each element. More... | |
| HashPtrTable (this_type &&rhs) noexcept | |
| Move construct. More... | |
| template<class INew > | |
| HashPtrTable (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. More... | |
| HashPtrTable (Istream &is) | |
| Construct from Istream using default Istream constructor class. More... | |
| HashPtrTable (const dictionary &dict) | |
| Construct from dictionary with default dictionary constructor class. More... | |
| ~HashPtrTable () | |
| Destructor. More... | |
| const T * | test (const Key &key) const |
| Return const pointer associated with given entry or a nullptr if the key does not exist in the table. More... | |
| const T * | get (const Key &key) const |
| Return const pointer associated with given entry or a nullptr if the key does not exist in the table. More... | |
| autoPtr< T > | release (iterator &iter) |
| Release ownership of the pointer and replace with a nullptr. More... | |
| autoPtr< T > | release (const Key &key) |
| Release ownership of the pointer and replace with a nullptr. More... | |
| autoPtr< T > | remove (iterator &iter) |
| Remove entry specified by given iterator. More... | |
| autoPtr< T > | remove (const Key &key) |
| Remove entry specified by given key. More... | |
| bool | erase (iterator &iter) |
| Erase entry specified by given iterator and delete the allocated pointer. More... | |
| bool | erase (const Key &key) |
| Erase entry specified by given key and delete the allocated pointer. More... | |
| void | clear () |
| Clear all entries from table and delete any allocated pointers. More... | |
| void | merge (HashPtrTable< T, Key, Hash > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| void | merge (HashPtrTable< T, Key, Hash > &&source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| void | write (Ostream &os) const |
| Invoke write() on each non-null entry. More... | |
| void | operator= (const this_type &rhs) |
| Copy assignment. More... | |
| void | operator= (this_type &&rhs) |
| Move assignment. More... | |
| template<class... Args> | |
| bool | emplace (const Key &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. More... | |
| template<class... Args> | |
| T & | emplace_set (const Key &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. More... | |
| template<class... Args> | |
| T & | try_emplace (const Key &key, Args &&... args) |
| Like emplace_set() but will not overwrite an occupied (non-null) location. More... | |
| bool | insert (const Key &, T *)=delete |
| No insert() with raw pointers (potential memory leaks). Use insert() with autoPtr or set() More... | |
| bool | insert (const Key &key, std::unique_ptr< T > &&ptr) |
| Insert a new entry, not overwriting existing entries. More... | |
| bool | insert (const Key &key, autoPtr< T > &&ptr) |
| Insert a new entry, not overwriting existing entries. More... | |
| bool | set (const Key &key, T *ptr) |
| Assign a new entry, overwrites existing. More... | |
| bool | set (const Key &key, std::unique_ptr< T > &&ptr) |
| Assign a new entry, overwrites existing. More... | |
| bool | set (const Key &key, autoPtr< T > &&ptr) |
| Assign a new entry, overwrites existing. More... | |
| bool | set (const Key &key, const refPtr< T > &ptr) |
| Assign a new entry from refPtr (move or clone), overwrites existing. More... | |
| bool | set (const Key &key, const tmp< T > &ptr) |
| Assign a new entry from tmp (move or clone), overwrites existing. More... | |
| bool | insert (const Key &key, autoPtr< T > &ptr) |
| Insert a new entry, not overwriting existing entries. More... | |
| bool | set (const Key &key, autoPtr< T > &ptr) |
| Assign a new entry, overwrites existing. More... | |
Public Member Functions inherited from HashTable< T *, Key, Hash > | |
| constexpr | HashTable () noexcept |
| Default construct: empty without allocation (capacity=0) More... | |
| constexpr | HashTable (Foam::zero) noexcept |
| Construct empty without allocation (capacity=0) More... | |
| HashTable (const label initialCapacity) | |
| Construct empty with initial table capacity. More... | |
| HashTable (Istream &is) | |
| Construct from Istream. More... | |
| HashTable (const this_type &ht) | |
| Copy construct. More... | |
| HashTable (this_type &&rhs) noexcept | |
| Move construct. More... | |
| HashTable (std::initializer_list< std::pair< Key, T * >> list, const bool overwrite=false) | |
| Construct from key/value pairs in initializer list. More... | |
| HashTable (const UList< Key > &keys, const UList< T * > &values, const bool overwrite=false) | |
| Construct from key/value pairs. More... | |
| ~HashTable () | |
| Destructor. More... | |
| bool | empty () const noexcept |
| True if the hash table is empty. More... | |
| label | size () const noexcept |
| The number of elements in table. More... | |
| label | capacity () const noexcept |
| The size of the underlying table (the number of buckets) More... | |
| T * & | at (const Key &key) |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| const T * & | at (const Key &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| bool | contains (const Key &key) const |
| True if hashed key is contained (found) in table. More... | |
| iterator | find (const Key &key) |
| Find and return an iterator set at the hashed entry. More... | |
| const_iterator | find (const Key &key) const |
| Find and return an const_iterator set at the hashed entry. More... | |
| const_iterator | cfind (const Key &key) const |
| Find and return an const_iterator set at the hashed entry. More... | |
| const T * & | lookup (const Key &key, const T * &deflt) const |
| Return hashed entry if it exists, or return the given default. More... | |
| List< Key > | toc () const |
| The table of contents (the keys) in unsorted order. More... | |
| List< Key > | sortedToc () const |
| The table of contents (the keys) in sorted order. More... | |
| List< Key > | sortedToc (const Compare &comp) const |
| The table of contents (the keys) sorted according to the specified comparator. More... | |
| Foam::List< Key > | sortedToc (const Compare &comp) const |
| List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the keys. More... | |
| Foam::List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| List< Key > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the values. More... | |
| Foam::List< Key > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More... | |
| Foam::List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| UPtrList< const node_type > | csorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). More... | |
| UPtrList< node_type > | sorted () |
| Non-const access to the hash-table contents in sorted order (sorted by keys). More... | |
| UPtrList< const node_type > | sorted () const |
| Deprecated(2023-07) use csorted() method. More... | |
| 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 Key &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. More... | |
| bool | emplace_set (const Key &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. More... | |
| bool | insert (const Key &key, const T * &obj) |
| Copy insert a new entry, not overwriting existing entries. More... | |
| bool | insert (const Key &key, T * &&obj) |
| Move insert a new entry, not overwriting existing entries. More... | |
| bool | set (const Key &key, const T * &obj) |
| Copy assign a new entry, overwriting existing entries. More... | |
| bool | set (const Key &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 Key &key) |
| Erase an entry specified by the given key. More... | |
| label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
| Remove table entries given by keys of the other hash-table. More... | |
| label | erase (std::initializer_list< Key > 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< Key, N > &keys) |
| Remove table entries given by the listed keys. More... | |
| label | erase (const UList< Key > &keys) |
| Remove table entries given by the listed keys. More... | |
| Foam::label | erase (InputIter first, InputIter last) |
| Foam::label | erase (const FixedList< Key, N > &keys) |
| Foam::label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
| label | retain (const HashTable< AnyType, Key, AnyHash > &other) |
| Retain table entries given by keys of the other hash-table. More... | |
| Foam::label | retain (const HashTable< AnyType, Key, 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 | clear () |
| Remove all entries from table. More... | |
| void | clearStorage () |
| Remove all entries from table and the table itself. More... | |
| void | setCapacity (label newCapacity) |
| Change the hash table capacity (number of buckets). More... | |
| void | resize (label newCapacity) |
| Rehash the hash table with new number of buckets. Currently identical to setCapacity() More... | |
| void | reserve (label numEntries) |
| Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More... | |
| void | swap (HashTable< T *, Key, Hash > &rhs) noexcept |
| Swap contents into this table. More... | |
| void | transfer (HashTable< T *, Key, Hash > &rhs) |
| Transfer contents into this table. More... | |
| void | merge (HashTable< T *, Key, Hash > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| void | merge (HashTable< T *, Key, Hash > &&source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. More... | |
| T * & | operator[] (const Key &key) |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| const T * & | operator[] (const Key &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| T * & | operator() (const Key &key) |
| Return existing entry or create a new entry. More... | |
| T * & | operator() (const Key &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< Key, T * >> rhs) |
| Copy assign from an initializer list. More... | |
| void | operator= (this_type &&rhs) |
| Move assign. More... | |
| bool | operator== (const this_type &rhs) const |
| Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More... | |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. More... | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. More... | |
| const_iterator_pair< const_key_iterator, this_type > | keys () 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... | |
| Ostream & | printInfo (Ostream &os) const |
| Print information. More... | |
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. More... | |
| bool | found (const Key &key) const |
| Same as contains() More... | |
Public Member Functions inherited from HashTableCore | |
| ClassName ("HashTable") | |
| Declare type-name (with debug switch) More... | |
| constexpr | HashTableCore () noexcept=default |
| Default construct. More... | |
Friends | |
| Istream & | operator>> (Istream &is, HashPtrTable< T, Key, Hash > &tbl) |
| Clear table and read from Istream. 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... | |
A HashTable of pointers to objects of type <T>, with deallocation management of the pointers.
Definition at line 51 of file HashPtrTable.H.
| typedef HashPtrTable<T, Key, Hash> this_type |
The template instance used for this table.
Definition at line 96 of file HashPtrTable.H.
| typedef HashTable<T*, Key, Hash> parent_type |
The template instance used for the parent HashTable.
Definition at line 101 of file HashPtrTable.H.
| using iterator = typename parent_type::iterator |
Definition at line 103 of file HashPtrTable.H.
| using const_iterator = typename parent_type::const_iterator |
Definition at line 104 of file HashPtrTable.H.
|
defaultnoexcept |
Default construct: empty without allocation (capacity=0)
|
inlineexplicitnoexcept |
Construct empty without allocation (capacity=0)
Definition at line 117 of file HashPtrTable.H.
|
inlineexplicit |
Construct given initial table capacity.
Definition at line 122 of file HashPtrTable.H.
| HashPtrTable | ( | const this_type & | rhs | ) |
Copy construct, making a copy of each element.
|
inlinenoexcept |
Move construct.
Definition at line 135 of file HashPtrTable.H.
| HashPtrTable | ( | Istream & | is, |
| const INew & | inew | ||
| ) |
Construct from Istream using given Istream constructor class.
Definition at line 152 of file HashPtrTableIO.C.
| HashPtrTable | ( | Istream & | is | ) |
Construct from Istream using default Istream constructor class.
Definition at line 159 of file HashPtrTableIO.C.
|
explicit |
Construct from dictionary with default dictionary constructor class.
Definition at line 166 of file HashPtrTableIO.C.
| ~HashPtrTable | ( | ) |
Destructor.
Definition at line 56 of file HashPtrTable.C.
|
inline |
Return const pointer associated with given entry or a nullptr if the key does not exist in the table.
Definition at line 28 of file HashPtrTableI.H.
|
inline |
Return const pointer associated with given entry or a nullptr if the key does not exist in the table.
Definition at line 41 of file HashPtrTableI.H.
| Foam::autoPtr< T > release | ( | iterator & | iter | ) |
Release ownership of the pointer and replace with a nullptr.
Includes a safeguard against the end-iterator.
Definition at line 65 of file HashPtrTable.C.
| Foam::autoPtr< T > release | ( | const Key & | key | ) |
Release ownership of the pointer and replace with a nullptr.
Definition at line 79 of file HashPtrTable.C.
| Foam::autoPtr< T > remove | ( | iterator & | iter | ) |
Remove entry specified by given iterator.
Includes a safeguard against the end-iterator.
Definition at line 87 of file HashPtrTable.C.
| Foam::autoPtr< T > remove | ( | const Key & | key | ) |
Remove entry specified by given key.
Definition at line 101 of file HashPtrTable.C.
| bool erase | ( | iterator & | iter | ) |
Erase entry specified by given iterator and delete the allocated pointer.
Includes a safeguard against the end-iterator.
Definition at line 109 of file HashPtrTable.C.
| bool erase | ( | const Key & | key | ) |
Erase entry specified by given key and delete the allocated pointer.
Definition at line 127 of file HashPtrTable.C.
| void clear | ( | ) |
Clear all entries from table and delete any allocated pointers.
Definition at line 135 of file HashPtrTable.C.
| void merge | ( | HashPtrTable< T, Key, Hash > & | source | ) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged.
Definition at line 148 of file HashPtrTable.C.
| void merge | ( | HashPtrTable< T, Key, Hash > && | source | ) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged.
Definition at line 160 of file HashPtrTable.C.
| void write | ( | Ostream & | os | ) | const |
Invoke write() on each non-null entry.
Definition at line 135 of file HashPtrTableIO.C.
|
inline |
Emplace insert a new entry, not overwriting existing entries.
Definition at line 56 of file HashPtrTableI.H.
|
inline |
Emplace set an entry, overwriting any existing entries.
Definition at line 109 of file HashPtrTableI.H.
|
inline |
Like emplace_set() but will not overwrite an occupied (non-null) location.
| key | - the location to set (unless already defined) |
| args | arguments to forward to the constructor of the element |
Definition at line 122 of file HashPtrTableI.H.
|
inlinedelete |
No insert() with raw pointers (potential memory leaks). Use insert() with autoPtr or set()
Referenced by HashPtrTable< exprResult >::insert().

|
inline |
Insert a new entry, not overwriting existing entries.
Definition at line 134 of file HashPtrTableI.H.
Insert a new entry, not overwriting existing entries.
Definition at line 151 of file HashPtrTableI.H.
|
inline |
Assign a new entry, overwrites existing.
Definition at line 168 of file HashPtrTableI.H.
Referenced by phaseSystem::addField(), exprResultGlobals::addValue(), phaseSystem::fillFields(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), filmTurbulenceModel::primaryRegionFriction(), and liquidFilmBase::Uw().

|
inline |
Assign a new entry, overwrites existing.
Definition at line 192 of file HashPtrTableI.H.
Assign a new entry, overwrites existing.
Definition at line 203 of file HashPtrTableI.H.
Assign a new entry from refPtr (move or clone), overwrites existing.
Definition at line 214 of file HashPtrTableI.H.
Assign a new entry from tmp (move or clone), overwrites existing.
Definition at line 225 of file HashPtrTableI.H.
Insert a new entry, not overwriting existing entries.
Definition at line 370 of file HashPtrTable.H.
Assign a new entry, overwrites existing.
Definition at line 378 of file HashPtrTable.H.
Clear table and read from Istream.