A HashTable similar to std::unordered_map. More...

Collaboration diagram for HashTable< T, Key, Hash >:

Classes
class	const_iterator
	Forward iterator with const access. More...

class	iterator
	Forward iterator with non-const access. More...

class	Iterator
	Internally used base for iterator and const_iterator. More...

class	key_iterator_base
	An iterator wrapper for returning a reference to the key. More...

Public Types
typedef HashTable< T, Key, Hash >	this_type
	The template instance used for this HashTable. 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 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
	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< Key, 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...

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	found (const Key &key) const
	Return true if hashed entry is 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...

template<class Compare >
List< Key >	sortedToc (const Compare &comp) const

template<class UnaryPredicate >
List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const

template<class UnaryPredicate >
List< Key >	tocValues (const UnaryPredicate &pred, const bool invert=false) const

template<class BinaryPredicate >
List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const

template<class UnaryPredicate >
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate. More...

template<class UnaryPredicate >
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate. More...

template<class BinaryPredicate >
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate. More...

template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...

template<class... Args>
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...

template<class AnyType , class AnyHash >
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...

template<class InputIter >
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys. More...

template<unsigned N>
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...

template<class AnyType , class AnyHash >
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table. More...

template<class UnaryPredicate >
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys. More...

template<class UnaryPredicate >
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values. More...

template<class BinaryPredicate >
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value. More...

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, Key, Hash > &rhs)
	Swap contents into this table. More...

void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table. 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

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

template<class Compare >
Foam::List< Key >	sortedToc (const Compare &comp) const

template<class UnaryPredicate >
Foam::List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::List< Key >	tocValues (const UnaryPredicate &pred, const bool invert) const

template<class BinaryPredicate >
Foam::List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const

template<class UnaryPredicate >
Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const

template<class BinaryPredicate >
Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const

template<class InputIter>
Foam::label	erase (InputIter first, InputIter last)

template<unsigned N>
Foam::label	erase (const FixedList< Key, N > &keys)

template<class AnyType, class AnyHash >
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &other)

template<class AnyType , class AnyHash >
Foam::label	retain (const HashTable< AnyType, Key, AnyHash > &other)

template<class UnaryPredicate >
Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)

template<class UnaryPredicate >
Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)

template<class BinaryPredicate >
Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)

Public Attributes
const typedef T *	const_pointer
	Const pointer type for the stored value_type. More...

const typedef T &	const_reference
	Const reference to the stored value_type. More...

Protected Member Functions
bool	iterator_erase (node_type *&entry, label &index)
	Low-level entry erasure using iterator internals. More...

Friends
class	Iterator< true >
	An iterator with const access to HashTable internals. More...

class	Iterator< false >
	An iterator with non-const access to HashTable internals. More...

Istream &	operator>> (Istream &, HashTable< T, Key, Hash > &tbl)

Ostream &	operator (Ostream &, const HashTable< T, Key, Hash > &tbl)

Detailed Description

template<class T, class Key = word, class Hash = Foam::Hash<Key>>
class Foam::HashTable< T, Key, Hash >

A HashTable similar to std::unordered_map.

The entries are considered unordered since their placement depends on the method used to generate the hash key index, the table capacity, insertion order etc. When the key order is important, use the sortedToc() method to obtain a list of sorted keys and use that for further access.

Internally the table uses closed addressing into a flat storage space with collisions handled by linked-list chaining.

The end iterator of all hash-tables has a nullptr to the hash entry. Thus avoid separate allocation for each table and use a single one with a nullptr. The hash-table iterators always have an entry-pointer as the first member data, which allows reinterpret_cast from anything else with a nullptr as its first data member. The nullObject is such an item (with a nullptr data member).

Note: For historical reasons, dereferencing the table iterator (eg, *iter) returns a reference to the stored object value rather than the stored key/val pair like std::unordered_map does.

The HashTable iterator:

forAllConstIters(table, iter)
{
    Info<< "val:" << *iter << nl
        << "key:" << iter.key() << nl;
        << "val:" << iter.val() << nl;
}

whereas for the std::unordered_map iterator:

forAllConstIters(stdmap, iter)
{
    Info<< "key/val:" << *iter << nl
        << "key:" << iter->first << nl
        << "val:" << iter->second << nl;
}

This difference is most evident when using range-for syntax.

Source files

Definition at line 105 of file HashTable.H.

Member Typedef Documentation

◆ this_type

typedef HashTable<T, Key, Hash> this_type

The template instance used for this HashTable.

Definition at line 166 of file HashTable.H.

◆ key_type

typedef Key key_type

The second template parameter, type of keys used.

Definition at line 172 of file HashTable.H.

◆ mapped_type

typedef T mapped_type

The first template parameter, type of objects contained.

Definition at line 175 of file HashTable.H.

◆ value_type

typedef T value_type

Same as mapped_type for OpenFOAM HashTables.

Note that this is different than the std::map definition.

Definition at line 179 of file HashTable.H.

◆ hasher

typedef Hash hasher

The third template parameter, the hash index method.

Definition at line 182 of file HashTable.H.

◆ pointer

typedef T* pointer

Pointer type for storing into value_type objects.

This type is usually 'value_type*'.

Definition at line 186 of file HashTable.H.

◆ reference

typedef T& reference

Reference to the stored value_type.

This type is usually 'value_type&'.

Definition at line 190 of file HashTable.H.

◆ difference_type

typedef label difference_type

The type to represent the difference between two iterators.

Definition at line 199 of file HashTable.H.

◆ size_type

typedef label size_type

The type that can represent the size of a HashTable.

Definition at line 202 of file HashTable.H.

◆ key_iterator

using key_iterator = key_iterator_base<iterator>

Forward iterator returning the key.

Definition at line 874 of file HashTable.H.

◆ const_key_iterator

using const_key_iterator = key_iterator_base<const_iterator>

Forward const iterator returning the key.

Definition at line 877 of file HashTable.H.

Constructor & Destructor Documentation

◆ HashTable() [1/6]

HashTable ( )

Default construct with default (128) table capacity.

Definition at line 39 of file HashTable.C.

◆ HashTable() [2/6]

HashTable ( const label size )

explicit

Construct given initial table capacity.

Definition at line 46 of file HashTable.C.

◆ HashTable() [3/6]

HashTable	(	Istream &	is,
		const label	size = `128`
	)

Construct from Istream with default table capacity.

Definition at line 36 of file HashTableIO.C.

◆ HashTable() [4/6]

HashTable ( const this_type & ht )

Copy construct.

◆ HashTable() [5/6]

HashTable ( this_type && rhs )

Move construct.

◆ HashTable() [6/6]

HashTable ( std::initializer_list< std::pair< Key, T >> list )

Construct from an initializer list.

Duplicate entries are handled by overwriting

Definition at line 92 of file HashTable.C.

◆ ~HashTable()

~HashTable ( )

Destructor.

Definition at line 108 of file HashTable.C.

Member Function Documentation

◆ capacity()

Foam::label capacity ( ) const

inlinenoexcept

The size of the underlying table.

Definition at line 45 of file HashTableI.H.

◆ size()

Foam::label size ( ) const

inlinenoexcept

The number of elements in table.

Definition at line 52 of file HashTableI.H.

Referenced by assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), boundaryMesh::changeFaces(), objectRegistry::classesImpl(), cyclicPolyPatch::coupledEdges(), faMeshDecomposition::decomposeMesh(), snappyRefineDriver::doRefine(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::erase(), Foam::eraseImpl(), InjectedParticleInjection< CloudType >::initialise(), blockMesh::mesh(), objectRegistry::namesImpl(), objectRegistry::namesTypeImpl(), polySurface::nPointData(), Foam::unitSet(), Foam::HashTableOps::values(), and meshRefinement::zonify().

Here is the caller graph for this function:

◆ empty()

bool empty ( ) const

inlinenoexcept

True if the hash table is empty.

Definition at line 59 of file HashTableI.H.

Referenced by forces::calcForcesMoment(), exprDriver::hasContextObjects(), argList::printMan(), and HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::retain().

Here is the caller graph for this function:

◆ at() [1/2]

T & at ( const Key & key )

inline

Find and return a hashed entry. FatalError if it does not exist.

Definition at line 66 of file HashTableI.H.

◆ at() [2/2]

const T & at ( const Key & key ) const

inline

Find and return a hashed entry. FatalError if it does not exist.

Definition at line 83 of file HashTableI.H.

◆ found()

bool found ( const Key & key ) const

inline

Return true if hashed entry is found in table.

Definition at line 100 of file HashTableI.H.

Referenced by BlendedInterfacialModel< wallLubricationModel >::BlendedInterfacialModel(), patchPatchDist::correct(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::erase(), fvMeshAdder::MapDimFields(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), orderedPhasePair::orderedPhasePair(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::retain(), and cuttingSurfaceBase::walkCellCuts().

Here is the caller graph for this function:

◆ find() [1/2]

Foam::HashTable< T, Key, Hash >::iterator find ( const Key & key )

inline

Find and return an iterator set at the hashed entry.

If not found iterator = end()

Definition at line 114 of file HashTableI.H.

Referenced by objectRegistry::checkOut(), cyclicPolyPatch::coupledEdges(), faMeshDecomposition::decomposeMesh(), FreeStream< CloudType >::FreeStream(), tetDecomposer::setRefinement(), meshReader::warnDuplicates(), and reader::warnDuplicates().

Here is the caller graph for this function:

◆ find() [2/2]

Foam::HashTable< T, Key, Hash >::const_iterator find ( const Key & key ) const

inline

Find and return an const_iterator set at the hashed entry.

If not found iterator = end()

Definition at line 130 of file HashTableI.H.

◆ cfind()

Foam::HashTable< T, Key, Hash >::const_iterator cfind ( const Key & key ) const

inline

Find and return an const_iterator set at the hashed entry.

If not found iterator = end()

Definition at line 141 of file HashTableI.H.

Referenced by STLAsciiParse::beginSolid(), Foam::stringOps::inplaceExpand(), blockMesh::mesh(), argList::printCompat(), and OBJsurfaceFormat< Face >::read().

Here is the caller graph for this function:

◆ lookup()

const T & lookup	(	const Key &	key,
		const T &	deflt
	)		const

inline

Return hashed entry if it exists, or return the given default.

Definition at line 224 of file HashTableI.H.

Referenced by cuttingSurfaceBase::walkCellCuts().

Here is the caller graph for this function:

◆ toc()

Foam::List< Key > toc ( ) const

The table of contents (the keys) in unsorted order.

Definition at line 121 of file HashTable.C.

Referenced by Foam::MapConsistentSubMesh(), objectRegistry::names(), and uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ sortedToc() [1/3]

Foam::List< Key > sortedToc ( ) const

The table of contents (the keys) in sorted order.

Definition at line 136 of file HashTable.C.

Referenced by snappyRefineDriver::doRefine(), DispersionRASModel< CloudType >::epsilonModel(), coupleGroupIdentifier::findOtherPatchID(), DispersionRASModel< CloudType >::kModel(), regionProperties::names(), externalCoupled::read(), objectRegistry::sortedNames(), ensightCase::write(), and meshRefinement::zonify().

Here is the caller graph for this function:

◆ sortedToc() [2/3]

List<Key> sortedToc ( const Compare & comp ) const

The table of contents (the keys) sorted according to the specified comparator

◆ tocKeys() [1/2]

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.

Parameters

invert changes the logic to select when the predicate is false

Returns: sorted list of selected keys

◆ tocValues() [1/2]

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.

Parameters

invert changes the logic to select when the predicate is false

Returns: sorted list of selected keys

◆ tocEntries() [1/2]

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.

Parameters

invert changes the logic to select when the predicate is false

Returns: sorted list of selected keys

◆ countKeys() [1/2]

label countKeys	(	const UnaryPredicate &	pred,
		const bool	invert = `false`
	)		const

Count the number of keys that satisfy the unary predicate.

Parameters

invert changes the logic to select when the predicate is false

◆ countValues() [1/2]

label countValues	(	const UnaryPredicate &	pred,
		const bool	invert = `false`
	)		const

Count the number of values that satisfy the unary predicate.

Parameters

invert changes the logic to select when the predicate is false

◆ countEntries() [1/2]

label countEntries	(	const BinaryPredicate &	pred,
		const bool	invert = `false`
	)		const

Count the number of entries that satisfy the binary predicate.

Parameters

invert changes the logic to select when the predicate is false

◆ emplace()

bool emplace	(	const Key &	key,
		Args &&...	args
	)

inline

Emplace insert a new entry, not overwriting existing entries.

Returns: True if the entry did not previously exist in the table.

Definition at line 157 of file HashTableI.H.

◆ emplace_set()

bool emplace_set	(	const Key &	key,
		Args &&...	args
	)

inline

Emplace set an entry, overwriting any existing entries.

Returns: True, since it always overwrites any entries.

Definition at line 169 of file HashTableI.H.

◆ insert() [1/2]

bool insert	(	const Key &	key,
		const T &	obj
	)

inline

Copy insert a new entry, not overwriting existing entries.

Returns: True if the entry did not previously exist in the table.

Definition at line 180 of file HashTableI.H.

Referenced by STLAsciiParse::beginSolid(), objectRegistry::checkIn(), patchPatchDist::correct(), cyclicPolyPatch::coupledEdges(), faMeshDecomposition::decomposeMesh(), phaseSystem::generatePhaseModels(), surfaceInterpolate::interpolateFields(), triSurfaceLoader::load(), objectRegistry::lookupClass(), Foam::MapConsistentSubMesh(), blockMesh::mesh(), OBJsurfaceFormat< Face >::read(), functionObjectList::read(), tetDecomposer::setRefinement(), cuttingSurfaceBase::walkCellCuts(), meshReader::warnDuplicates(), reader::warnDuplicates(), and meshRefinement::zonify().

Here is the caller graph for this function:

◆ insert() [2/2]

bool insert	(	const Key &	key,
		T &&	obj
	)

inline

Move insert a new entry, not overwriting existing entries.

Returns: True if the entry did not previously exist in the table.

Definition at line 191 of file HashTableI.H.

◆ set() [1/2]

bool set	(	const Key &	key,
		const T &	obj
	)

inline

Copy assign a new entry, overwriting existing entries.

Returns: True, since it always overwrites any entries.

Definition at line 202 of file HashTableI.H.

Referenced by fvMeshDistribute::distribute().

Here is the caller graph for this function:

◆ set() [2/2]

bool set	(	const Key &	key,
		T &&	obj
	)

inline

Move assign a new entry, overwriting existing entries.

Returns: True, since it always overwrites any entries.

Definition at line 213 of file HashTableI.H.

◆ erase() [1/10]

bool erase ( const iterator & iter )

Erase an entry specified by given iterator.

This invalidates the iterator until the next ++ operation.

Includes a safeguard against the end-iterator such that the following is safe:

auto iter = table.find(unknownKey);

table.erase(iter);

which is what

table.erase(unknownKey)

does anyhow.

Returns: True if the corresponding entry existed and was removed

Definition at line 392 of file HashTable.C.

Referenced by cyclicPolyPatch::coupledEdges(), and objectRegistry::erase().

Here is the caller graph for this function:

◆ erase() [2/10]

bool erase ( const Key & key )

Erase an entry specified by the given key.

Returns: True if the entry existed and was removed

Definition at line 406 of file HashTable.C.

◆ erase() [3/10]

label erase ( const HashTable< AnyType, Key, AnyHash > & other )

Remove table entries given by keys of the other hash-table.

The other hash-table must have the same type of key, but the type of values held and the hashing function are arbitrary.

Returns: The number of items removed

◆ erase() [4/10]

Foam::label erase ( std::initializer_list< Key > keys )

inline

Remove table entries given by the listed keys.

Returns: The number of items removed

Definition at line 442 of file HashTable.C.

◆ erase() [5/10]

label erase	(	InputIter	first,
		InputIter	last
	)

inline

Remove multiple entries using an iterator range of keys.

◆ erase() [6/10]

label erase ( const FixedList< Key, N > & keys )

inline

Remove table entries given by the listed keys.

Returns: The number of items removed

◆ erase() [7/10]

Foam::label erase ( const UList< Key > & keys )

inline

Remove table entries given by the listed keys.

Returns: The number of items removed

Definition at line 463 of file HashTable.C.

◆ retain() [1/2]

label retain ( const HashTable< AnyType, Key, AnyHash > & other )

Retain table entries given by keys of the other hash-table.

The other hash-table must have the same type of key, but the type of values held and the hashing function are arbitrary.

Returns: The number of items changed (removed)

◆ filterKeys() [1/2]

label filterKeys	(	const UnaryPredicate &	pred,
		const bool	pruning = `false`
	)

Generalized means to filter table entries based on their keys.

Keep (or optionally prune) entries with keys that satisfy the unary predicate, which has the following signature:

bool operator()(const Key& k);

For example,

wordRes goodFields = ...;
allFieldNames.filterKeys
(
    [&goodFields](const word& k){ return goodFields.match(k); }
);

Returns: The number of items changed (removed)

◆ filterValues() [1/2]

label filterValues	(	const UnaryPredicate &	pred,
		const bool	pruning = `false`
	)

Generalized means to filter table entries based on their values.

Keep (or optionally prune) entries with values that satisfy the unary predicate, which has the following signature:

bool operator()(const T& v);

Returns: The number of items changed (removed)

◆ filterEntries() [1/2]

label filterEntries	(	const BinaryPredicate &	pred,
		const bool	pruning = `false`
	)

Generalized means to filter table entries based on their key/value.

Keep (or optionally prune) entries with keys/values that satisfy the binary predicate, which has the following signature:

bool operator()(const Key& k, const T& v);

Returns: The number of items changed (removed)

◆ resize()

void resize ( const label sz )

Resize the hash table for efficiency.

Definition at line 553 of file HashTable.C.

◆ clear()

void clear ( )

Clear all entries from table.

Definition at line 630 of file HashTable.C.

Referenced by objectRegistry::clear(), wallBoundedStreamLine::read(), tetDecomposer::setRefinement(), cuttingSurfaceBase::walkCellCuts(), and areaWrite::write().

Here is the caller graph for this function:

◆ clearStorage()

void clearStorage ( )

Clear the table entries and the table itself.

Equivalent to clear() followed by resize(0)

Definition at line 649 of file HashTable.C.

Referenced by objectRegistry::clearStorage().

Here is the caller graph for this function:

◆ swap()

void swap ( HashTable< T, Key, Hash > & rhs )

Swap contents into this table.

Definition at line 657 of file HashTable.C.

◆ transfer()

void transfer ( HashTable< T, Key, Hash > & rhs )

Transfer contents into this table.

Definition at line 671 of file HashTable.C.

Referenced by extendedEdgeMesh::transfer().

Here is the caller graph for this function:

◆ operator[]() [1/2]

T & operator[] ( const Key & key )

inline

Find and return a hashed entry. FatalError if it does not exist.

Definition at line 237 of file HashTableI.H.

◆ operator[]() [2/2]

const T & operator[] ( const Key & key ) const

inline

Find and return a hashed entry. FatalError if it does not exist.

Definition at line 244 of file HashTableI.H.

◆ operator()() [1/2]

T & operator() ( const Key & key )

inline

Return existing entry or create a new entry.

A newly created entry is created as a nameless T() and is thus value-initialized. For primitives, this will be zero.

Definition at line 251 of file HashTableI.H.

◆ operator()() [2/2]

T & operator()	(	const Key &	key,
		const T &	deflt
	)

inline

Return existing entry or insert a new entry.

Definition at line 267 of file HashTableI.H.

◆ operator=() [1/3]

void operator= ( const this_type & rhs )

Copy assign.

Referenced by Map< patchControl >::operator=(), and HashSet< word, Hash< word > >::operator=().

Here is the caller graph for this function:

◆ operator=() [2/3]

void operator= ( std::initializer_list< std::pair< Key, T >> rhs )

Copy assign from an initializer list.

Duplicate entries are handled by overwriting

Definition at line 796 of file HashTable.C.

◆ operator=() [3/3]

void operator= ( this_type && rhs )

Move assign.

◆ operator==()

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.

Definition at line 834 of file HashTable.C.

◆ operator!=()

bool operator!= ( const this_type & rhs ) const

The opposite of the equality operation.

Definition at line 860 of file HashTable.C.

◆ operator+=()

Foam::HashTable< T, Key, Hash > & operator+= ( const this_type & rhs )

Add entries into this HashTable.

Definition at line 870 of file HashTable.C.

◆ iterator_erase()

bool iterator_erase	(	node_type *&	entry,
		label &	index
	)

protected

Low-level entry erasure using iterator internals.

This invalidates the iterator until the next ++ operation.

Returns: True if the corresponding entry existed and was removed

Definition at line 66 of file HashTableIter.C.

◆ keys()

const_iterator_pair<const_key_iterator, this_type> keys ( ) const

inline

A const iterator begin/end pair for iterating over keys.

Definition at line 880 of file HashTable.H.

◆ begin() [1/2]

Foam::HashTable< T, Key, Hash >::iterator begin ( )

inline

iterator set to the beginning of the HashTable

Definition at line 232 of file HashTableIterI.H.

Referenced by HashSet< word, Hash< word > >::begin().

Here is the caller graph for this function:

◆ begin() [2/2]

Foam::HashTable< T, Key, Hash >::const_iterator begin ( ) const

inline

const_iterator set to the beginning of the HashTable

Definition at line 240 of file HashTableIterI.H.

◆ cbegin()

Foam::HashTable< T, Key, Hash >::const_iterator cbegin ( ) const

inline

const_iterator set to the beginning of the HashTable

Definition at line 248 of file HashTableIterI.H.

Referenced by HashSet< word, Hash< word > >::cbegin(), HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::erase(), phaseSystem::generatePhi(), hashedWordList::hashedWordList(), and HashSet< word, Hash< word > >::HashSet().

Here is the caller graph for this function:

◆ end() [1/2]

Foam::HashTable< T, Key, Hash >::iterator end ( )

inlinenoexcept

iterator to signal the end (for any HashTable)

Definition at line 256 of file HashTableIterI.H.

Referenced by tetDecomposer::setRefinement().

Here is the caller graph for this function:

◆ end() [2/2]

Foam::HashTable< T, Key, Hash >::const_iterator end ( ) const

inlinenoexcept

const_iterator to signal the end (for any HashTable)

Definition at line 264 of file HashTableIterI.H.

◆ cend()

constexpr Foam::HashTable< T, Key, Hash >::const_iterator cend ( ) const

inlineconstexprnoexcept

const_iterator to signal the end (for any HashTable)

Definition at line 272 of file HashTableIterI.H.

Referenced by HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::erase(), phaseSystem::generatePhi(), hashedWordList::hashedWordList(), and HashSet< word, Hash< word > >::HashSet().

Here is the caller graph for this function:

◆ printInfo()

Foam::Ostream & printInfo ( Ostream & os ) const

Print information.

Definition at line 60 of file HashTableIO.C.

◆ writeKeys()

Foam::Ostream & writeKeys	(	Ostream &	os,
		const label	shortLen = `0`
	)		const

Write unordered keys (list), with line-breaks when length exceeds shortLen.

Using '0' suppresses line-breaks entirely.

Definition at line 97 of file HashTableIO.C.

◆ sortedToc() [3/3]

Foam::List<Key> sortedToc ( const Compare & comp ) const

Definition at line 148 of file HashTable.C.

◆ tocKeys() [2/2]

Foam::List<Key> tocKeys	(	const UnaryPredicate &	pred,
		const bool	invert
	)		const

Definition at line 162 of file HashTable.C.

◆ tocValues() [2/2]

Foam::List<Key> tocValues	(	const UnaryPredicate &	pred,
		const bool	invert
	)		const

Definition at line 188 of file HashTable.C.

◆ tocEntries() [2/2]

Foam::List<Key> tocEntries	(	const BinaryPredicate &	pred,
		const bool	invert
	)		const

Definition at line 214 of file HashTable.C.

◆ countKeys() [2/2]

Foam::label countKeys	(	const UnaryPredicate &	pred,
		const bool	invert
	)		const

Definition at line 240 of file HashTable.C.

◆ countValues() [2/2]

Foam::label countValues	(	const UnaryPredicate &	pred,
		const bool	invert
	)		const

Definition at line 262 of file HashTable.C.

◆ countEntries() [2/2]

Foam::label countEntries	(	const BinaryPredicate &	pred,
		const bool	invert
	)		const

Definition at line 284 of file HashTable.C.

◆ erase() [8/10]

Foam::label erase	(	InputIter	first,
		InputIter	last
	)

inline

Definition at line 416 of file HashTable.C.

◆ erase() [9/10]

Foam::label erase ( const FixedList< Key, N > & keys )

inline

Definition at line 453 of file HashTable.C.

◆ erase() [10/10]

Foam::label erase ( const HashTable< AnyType, Key, AnyHash > & other )

Definition at line 474 of file HashTable.C.

◆ retain() [2/2]

Foam::label retain ( const HashTable< AnyType, Key, AnyHash > & other )

Definition at line 522 of file HashTable.C.

◆ filterKeys() [2/2]

Foam::label filterKeys	(	const UnaryPredicate &	pred,
		const bool	pruning
	)

Definition at line 686 of file HashTable.C.

◆ filterValues() [2/2]

Foam::label filterValues	(	const UnaryPredicate &	pred,
		const bool	pruning
	)

Definition at line 713 of file HashTable.C.

◆ filterEntries() [2/2]

Foam::label filterEntries	(	const BinaryPredicate &	pred,
		const bool	pruning
	)

Definition at line 740 of file HashTable.C.

Friends And Related Function Documentation

◆ Iterator< true >

friend class Iterator< true >

friend

An iterator with const access to HashTable internals.

Definition at line 214 of file HashTable.H.

Referenced by HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::begin(), and HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::cbegin().

◆ Iterator< false >

friend class Iterator< false >

friend

An iterator with non-const access to HashTable internals.

Definition at line 220 of file HashTable.H.

Referenced by HashTable< Foam::autoPtr< Foam::interfaceCompositionModel > >::begin().

◆ operator>>

Istream& operator>>	(	Istream &	,
		HashTable< T, Key, Hash > &	tbl
	)

friend

◆ operator

Ostream& operator	(	Ostream &	,
		const HashTable< T, Key, Hash > &	tbl
	)

friend

Member Data Documentation

◆ const_pointer

const typedef T* const_pointer

Const pointer type for the stored value_type.

Definition at line 193 of file HashTable.H.

◆ const_reference

const typedef T& const_reference

Const reference to the stored value_type.

Definition at line 196 of file HashTable.H.

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

src/OpenFOAM/containers/HashTables/HashTable/HashTable.H
src/OpenFOAM/containers/HashTables/HashTable/HashTable.C
src/OpenFOAM/containers/HashTables/HashTable/HashTableI.H
src/OpenFOAM/containers/HashTables/HashTable/HashTableIO.C
src/OpenFOAM/containers/HashTables/HashTable/HashTableIter.C
src/OpenFOAM/containers/HashTables/HashTable/HashTableIterI.H

Classes

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

template<class T, class Key = word, class Hash = Foam::Hash<Key>> class Foam::HashTable< T, Key, Hash >

Member Typedef Documentation

◆ this_type

◆ key_type

◆ mapped_type

◆ value_type

◆ hasher

◆ pointer

◆ reference

◆ difference_type

◆ size_type

◆ key_iterator

◆ const_key_iterator

Constructor & Destructor Documentation

◆ HashTable() [1/6]

◆ HashTable() [2/6]

◆ HashTable() [3/6]

◆ HashTable() [4/6]

◆ HashTable() [5/6]

◆ HashTable() [6/6]

◆ ~HashTable()

Member Function Documentation

◆ capacity()

◆ size()

◆ empty()

◆ at() [1/2]

◆ at() [2/2]

◆ found()

◆ find() [1/2]

◆ find() [2/2]

◆ cfind()

◆ lookup()

◆ toc()

◆ sortedToc() [1/3]

◆ sortedToc() [2/3]

◆ tocKeys() [1/2]

◆ tocValues() [1/2]

◆ tocEntries() [1/2]

◆ countKeys() [1/2]

◆ countValues() [1/2]

◆ countEntries() [1/2]

◆ emplace()

◆ emplace_set()

◆ insert() [1/2]

◆ insert() [2/2]

◆ set() [1/2]

◆ set() [2/2]

◆ erase() [1/10]

◆ erase() [2/10]

◆ erase() [3/10]

◆ erase() [4/10]

◆ erase() [5/10]

◆ erase() [6/10]

◆ erase() [7/10]

◆ retain() [1/2]

◆ filterKeys() [1/2]

◆ filterValues() [1/2]

◆ filterEntries() [1/2]

◆ resize()

◆ clear()

◆ clearStorage()

◆ swap()

◆ transfer()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ operator!=()

◆ operator+=()

template<class T, class Key = word, class Hash = Foam::Hash<Key>>
class Foam::HashTable< T, Key, Hash >