Map from edge (expressed as its endpoints) to value. Hashing (and ==) on an edge is symmetric. More...
#include <edgeHashes.H>
Additional Inherited Members | |
| Public Types inherited from HashTable< T, edge, Hash< edge > > | |
| typedef HashTable< T, edge, Hash > | this_type |
| The template instance used for this HashTable. | |
| using | node_type |
| A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. | |
| typedef edge | key_type |
| The second template parameter, type of keys used. | |
| typedef T | mapped_type |
| The first template parameter, type of objects contained. | |
| typedef T | value_type |
| Same as mapped_type for OpenFOAM HashTables. | |
| typedef Hash | hasher |
| The third template parameter, the hash index method. | |
| typedef T * | pointer |
| Pointer type for storing into value_type objects. | |
| typedef T & | reference |
| Reference to the stored value_type. | |
| typedef const T * | const_pointer |
| Const pointer type for the stored value_type. | |
| typedef const T & | const_reference |
| Const reference to the stored value_type. | |
| typedef label | difference_type |
| The type to represent the difference between two iterators. | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. | |
| using | key_iterator |
| Forward iterator returning the key. | |
| using | const_key_iterator |
| Forward const iterator returning the key. | |
| Public Member Functions inherited from HashTable< T, edge, Hash< edge > > | |
| Foam::List< edge > | sortedToc (const Compare &comp) const |
| Foam::List< edge > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< edge > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< edge > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | erase (InputIter first, InputIter last) |
| Foam::label | erase (const FixedList< edge, N > &keys) |
| Foam::label | erase (const HashTable< AnyType, edge, AnyHash > &other) |
| Foam::label | retain (const HashTable< AnyType, edge, AnyHash > &other) |
| Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
| constexpr | HashTable () noexcept |
| Default construct: empty without allocation (capacity=0). | |
| ~HashTable () | |
| Destructor. | |
| bool | empty () const noexcept |
| True if the hash table is empty. | |
| label | size () const noexcept |
| The number of elements in table. | |
| label | capacity () const noexcept |
| The size of the underlying table (the number of buckets). | |
| T & | at (const edge &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| bool | contains (const edge &key) const |
| True if hashed key is contained (found) in table. | |
| iterator | find (const edge &key) |
| Find and return an iterator set at the hashed entry. | |
| const_iterator | cfind (const edge &key) const |
| Find and return an const_iterator set at the hashed entry. | |
| const T & | lookup (const edge &key, const T &deflt) const |
| Return hashed entry if it exists, or return the given default. | |
| List< edge > | toc () const |
| The table of contents (the keys) in unsorted order. | |
| UPtrList< const node_type > | csorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). | |
| UPtrList< node_type > | sorted () |
| Non-const access to the hash-table contents in sorted order (sorted by keys). | |
| bool | emplace (const edge &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. | |
| bool | emplace_set (const edge &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. | |
| bool | insert (const edge &key, const T &obj) |
| Copy insert a new entry, not overwriting existing entries. | |
| bool | set (const edge &key, const T &obj) |
| Copy assign a new entry, overwriting existing entries. | |
| void | clear () |
| Remove all entries from table. | |
| void | clearStorage () |
| Remove all entries from table and the table itself. | |
| void | setCapacity (label newCapacity) |
| Change the hash table capacity (number of buckets). | |
| void | resize (label newCapacity) |
| Rehash the hash table with new number of buckets. Currently identical to setCapacity(). | |
| void | reserve (label numEntries) |
| Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. | |
| void | swap (HashTable< T, edge, Hash > &rhs) noexcept |
| Swap contents into this table. | |
| void | transfer (HashTable< T, edge, Hash > &rhs) |
| Transfer contents into this table. | |
| void | merge (HashTable< T, edge, 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. | |
| T & | operator[] (const edge &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| T & | operator() (const edge &key) |
| Return existing entry or create a new entry. | |
| void | operator= (const this_type &rhs) |
| Copy assign. | |
| 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. | |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. | |
| const_iterator_pair< const_key_iterator, this_type > | keys () const |
| A const iterator begin/end pair for iterating over keys. | |
| iterator | begin () |
| iterator set to the beginning of the HashTable | |
| const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable | |
| iterator | end () noexcept |
| iterator to signal the end (for any HashTable) | |
| constexpr const_iterator | cend () const noexcept |
| const_iterator to signal the end (for any HashTable) | |
| Ostream & | printInfo (Ostream &os) const |
| Print information. | |
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. | |
| bool | found (const edge &key) const |
| Same as contains(). | |
| Public Member Functions inherited from HashTableCore | |
| ClassName ("HashTable") | |
| Declare type-name (with debug switch). | |
| constexpr | HashTableCore () noexcept=default |
| Default construct. | |
| Static Public Member Functions inherited from HashTableCore | |
| static label | canonicalSize (const label size) noexcept |
| Return a canonical (power-of-two) of the requested size. | |
| Static Public Attributes inherited from HashTableCore | |
| static constexpr int32_t | maxTableSize = (1 << (32-3)) |
| Maximum allowable internal table size (must be a power of two!). | |
Map from edge (expressed as its endpoints) to value. Hashing (and ==) on an edge is symmetric.
Definition at line 56 of file edgeHashes.H.
1.16.1 