HashTable< T, Key, Hash > Class Template Reference

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

#include <HashTable.H>

Inherits HashTableCore.

Inherited by EdgeMap< labelPairHashSet >, HashPtrTable< T, label, Hash< label > >, HashPtrTable< multiphaseEuler::dragModel, interfacePair, interfacePair::symmHash >, HashPtrTable< volScalarField, interfacePair, interfacePair::symmHash >, HashPtrTable< volScalarField, phasePairKey, phasePairKey::hash >, HashPtrTable< fvVectorMatrix >, HashPtrTable< fvScalarMatrix >, HashPtrTable< HashPtrTable< volScalarField >, phasePairKey, phasePairKey::hash >, HashPtrTable< surfaceScalarField, phasePairKey, phasePairKey::hash >, HashPtrTable< ThermoType >, HashPtrTable< IOobject >, HashPtrTable< exprResult >, HashPtrTable< curve >, HashPtrTable< Foam::GeometricField< scalar, fvsPatchField, surfaceMesh > >, HashPtrTable< Foam::OFstream >, HashPtrTable< Foam::surfaceWriter >, HashPtrTable< Foam::colourTable >, HashPtrTable< Foam::DynamicList< Foam::instant > >, HashPtrTable< Foam::Function1< Type > >, HashPtrTable< Foam::Function1< scalar > >, HashPtrTable< Foam::expressions::volumeExpr::parseDriver >, HashPtrTable< Foam::Field< scalar > >, HashPtrTable< Foam::Field< vector > >, HashPtrTable< Foam::Field< sphericalTensor > >, HashPtrTable< Foam::Field< symmTensor > >, HashPtrTable< Foam::Field< tensor > >, HashPtrTable< Foam::lumpedPointController >, HashSet< Key, HashType >, HashSet< word, Hash< word > >, HashSet< label, Hash< label > >, HashSet< edge, Hash< edge > >, HashSet< labelPair, Foam::Hash< labelPair > >, HashSet< wordPair, Foam::Hash< wordPair > >, HashSet< labelPairPair >, HashSet< Foam::string >, HashSet< Foam::fileName >, Map< interfaceEntry >, HashPtrTable< T, Key, Hash >, and HashSet< Key, Hash >.

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

Classes
class	Iterator
	Internally used base for iterator and const_iterator. More...
class	iterator
	Forward iterator with non-const access. More...
class	const_iterator
	Forward iterator with const access. 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.
using	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions.
typedef Key	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 = key_iterator_base<iterator>
	Forward iterator returning the key.
using	const_key_iterator = key_iterator_base<const_iterator>
	Forward const iterator returning the key.

Public Member Functions
constexpr	HashTable () noexcept
	Default construct: empty without allocation (capacity=0).
constexpr	HashTable (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashTable (const label initialCapacity)
	Construct empty with initial table capacity.
	HashTable (Istream &is)
	Construct from Istream.
	HashTable (const this_type &ht)
	Copy construct.
	HashTable (this_type &&rhs) noexcept
	Move construct.
	HashTable (std::initializer_list< std::pair< Key, T > > list, const bool overwrite=false)
	Construct from key/value pairs in initializer list.
	HashTable (const UList< Key > &keys, const UList< T > &values, const bool overwrite=false)
	Construct from key/value pairs.
	~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 Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
bool	contains (const Key &key) const
	True if hashed key is contained (found) in table.
iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry.
const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const T &	lookup (const Key &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default.
List< Key >	toc () const
	The table of contents (the keys) in unsorted order.
List< Key >	sortedToc () const
	The table of contents (the keys) in sorted order.
template<class Compare>
List< Key >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator.
template<class UnaryPredicate>
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.
template<class UnaryPredicate>
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.
template<class BinaryPredicate>
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.
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).
template<class UnaryPredicate>
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate.
template<class UnaryPredicate>
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate.
template<class BinaryPredicate>
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate.
template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries.
template<class... Args>
bool	emplace_set (const Key &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries.
bool	insert (const Key &key, const T &obj)
	Copy insert a new entry, not overwriting existing entries.
bool	insert (const Key &key, T &&obj)
	Move insert a new entry, not overwriting existing entries.
bool	set (const Key &key, const T &obj)
	Copy assign a new entry, overwriting existing entries.
bool	set (const Key &key, T &&obj)
	Move assign a new entry, overwriting existing entries.
bool	erase (const iterator &iter)
	Erase an entry specified by given iterator.
bool	erase (const Key &key)
	Erase an entry specified by the given key.
template<class AnyType, class AnyHash>
label	erase (const HashTable< AnyType, Key, AnyHash > &other)
	Remove table entries given by keys of the other hash-table.
label	erase (std::initializer_list< Key > keys)
	Remove table entries given by the listed keys.
template<class InputIter>
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys.
template<unsigned N>
label	erase (const FixedList< Key, N > &keys)
	Remove table entries given by the listed keys.
label	erase (const UList< Key > &keys)
	Remove table entries given by the listed keys.
template<class AnyType, class AnyHash>
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table.
template<class UnaryPredicate>
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys.
template<class UnaryPredicate>
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values.
template<class BinaryPredicate>
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value.
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, Key, Hash > &rhs) noexcept
	Swap contents into this table.
void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table.
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.
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.
T &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
T &	operator() (const Key &key)
	Return existing entry or create a new entry.
T &	operator() (const Key &key, const T &deflt)
	Return existing entry or insert a new entry.
void	operator= (const this_type &rhs)
	Copy assign.
void	operator= (std::initializer_list< std::pair< Key, T > > rhs)
	Copy assign from an initializer list.
void	operator= (this_type &&rhs)
	Move 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	begin () const
	const_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)
const_iterator	end () const noexcept
	const_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 Key &key) const
	Same as contains().
UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method.
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 Member Functions inherited from HashTableCore
	ClassName ("HashTable")
	Declare type-name (with debug switch).
constexpr	HashTableCore () noexcept=default
	Default construct.

Friends
class	Iterator< true >
	Allow iterator access to HashTable internals.
class	Iterator< false >
	Allow iterator access to HashTable internals.
Istream &	operator>> (Istream &, HashTable< T, Key, Hash > &tbl)
Ostream &	operator (Ostream &, const HashTable< T, Key, Hash > &tbl)

Additional Inherited Members
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!).

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, or the csorted()/sorted() methods to obtain a UPtrList of entries to traverse in sorted order.

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

• The max_load_factor is 0.8, but a load factor 0.5 is generally assumed when initially creating a HashTable (ie, use an capacity of twice the expected number elements).
• When inserting into a table without an initial capacity, a default capacity (bucket count) of 128 is used.

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

• HashTable.H
• HashTableI.H
• HashTableIterI.H
• HashTable.C
• HashTableIO.C
• HashTableIter.C

Definition at line 121 of file HashTable.H.

Member Typedef Documentation

this_type

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

typedef HashTable<T, Key, Hash> this_type

The template instance used for this HashTable.

Definition at line 132 of file HashTable.H.

node_type

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

using node_type

Initial value:

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.

Definition at line 138 of file HashTable.H.

key_type

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

typedef Key key_type

The second template parameter, type of keys used.

Definition at line 151 of file HashTable.H.

mapped_type

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

typedef T mapped_type

The first template parameter, type of objects contained.

Definition at line 156 of file HashTable.H.

value_type

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

typedef T value_type

Same as mapped_type for OpenFOAM HashTables.

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

Definition at line 163 of file HashTable.H.

hasher

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

typedef Hash hasher

The third template parameter, the hash index method.

Definition at line 168 of file HashTable.H.

pointer

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

typedef T* pointer

Pointer type for storing into value_type objects.

This type is usually 'value_type*'.

Definition at line 175 of file HashTable.H.

reference

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

typedef T& reference

Reference to the stored value_type.

This type is usually 'value_type&'.

Definition at line 182 of file HashTable.H.

const_pointer

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

typedef const T* const_pointer

Const pointer type for the stored value_type.

Definition at line 187 of file HashTable.H.

const_reference

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

typedef const T& const_reference

Const reference to the stored value_type.

Definition at line 192 of file HashTable.H.

difference_type

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

typedef label difference_type

The type to represent the difference between two iterators.

Definition at line 197 of file HashTable.H.

size_type

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

typedef label size_type

The type that can represent the size of a HashTable.

Definition at line 202 of file HashTable.H.

key_iterator

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

using key_iterator = key_iterator_base<iterator>

Forward iterator returning the key.

Definition at line 1285 of file HashTable.H.

const_key_iterator

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

using const_key_iterator = key_iterator_base<const_iterator>

Forward const iterator returning the key.

Definition at line 1290 of file HashTable.H.

Constructor & Destructor Documentation

HashTable() [1/8]

template<class T, class Key, class Hash>

HashTable ( )

constexprnoexcept

Default construct: empty without allocation (capacity=0).

Definition at line 33 of file HashTable.C.

References HashTableCore::HashTableCore(), and Foam::noexcept.

Referenced by HashSet< Key, Hash >::HashSet(), HashSet< Key, HashType >::HashSet(), HashTable(), HashTable(), HashTable(), HashTable(), merge(), merge(), operator!=(), operator+=(), operator==(), swap(), and transfer().

Here is the call graph for this function:

Here is the caller graph for this function:

HashTable() [2/8]

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

HashTable ( Foam::zero )

inlineexplicitconstexprnoexcept

Construct empty without allocation (capacity=0).

Definition at line 294 of file HashTable.H.

HashTable() [3/8]

template<class T, class Key, class Hash>

HashTable ( const label initialCapacity )

explicit

Construct empty with initial table capacity.

Definition at line 43 of file HashTable.C.

References HashTableCore::canonicalSize(), HashTable(), and Foam::T().

Here is the call graph for this function:

HashTable() [4/8]

template<class T, class Key, class Hash>

HashTable

(

Istream &

is

)

Construct from Istream.

Definition at line 29 of file HashTableIO.C.

References HashTable(), operator>>, and Foam::T().

Here is the call graph for this function:

HashTable() [5/8]

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

HashTable

(

const this_type &

ht

)

Copy construct.

HashTable() [6/8]

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

HashTable ( this_type && rhs )

noexcept

Move construct.

HashTable() [7/8]

template<class T, class Key, class Hash>

HashTable	(	std::initializer_list< std::pair< Key, T > >	list,
		const bool	overwrite = false )

Construct from key/value pairs in initializer list.

By default, uses insert not overwrite semantics for duplicates.

Definition at line 85 of file HashTable.C.

References HashTable(), reserve(), and Foam::T().

Here is the call graph for this function:

HashTable() [8/8]

template<class T, class Key, class Hash>

HashTable	(	const UList< Key > &	keys,
		const UList< T > &	values,
		const bool	overwrite = false )

Construct from key/value pairs.

By default, uses insert not overwrite semantics for duplicates.

Definition at line 103 of file HashTable.C.

References HashTable(), keys(), reserve(), and Foam::T().

Here is the call graph for this function:

~HashTable()

template<class T, class Key, class Hash>

~HashTable

(

)

Destructor.

Definition at line 126 of file HashTable.C.

References clear().

Here is the call graph for this function:

Member Function Documentation

empty()

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

bool empty ( ) const

inlinenoexcept

True if the hash table is empty.

Definition at line 353 of file HashTable.H.

Referenced by faBoundaryMesh::indices(), faBoundaryMesh::indices(), faBoundaryMesh::indices(), pointBoundaryMesh::indices(), pointBoundaryMesh::indices(), pointBoundaryMesh::indices(), polyBoundaryMesh::indices(), polyBoundaryMesh::indices(), polyBoundaryMesh::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), interfaceDefinitions::interfaceDefinitions(), Probes< ProbeType >::prepare(), wallShearStress::read(), HashTable< T, Key, HashType >::retain(), and globalIndexAndTransform::transformIndicesForPatches().

Here is the caller graph for this function:

size()

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

label size ( ) const

inlinenoexcept

The number of elements in table.

Definition at line 358 of file HashTable.H.

Referenced by singleProcessorFaceSets::add(), cellTable::addCellZones(), faMesh::boundaryProcSizes(), faPatch::boundaryProcSizes(), cellToFaceStencil::calcFaceStencil(), createShellMesh::calcPointRegions(), extractEulerianParticles::calculateAddressing(), GAMGAgglomeration::calculateRegionMaster(), pointMVCWeight::calcWeights(), boundaryMesh::changeFaces(), primitiveMesh::checkEdgeLength(), Foam::checkFireEdges(), motionSmootherAlgo::checkMesh(), motionSmootherAlgo::checkMesh(), edgeCollapser::checkMeshQuality(), coalCloudList::coalCloudList(), cellTable::combine(), hexRef8::consistentSlowRefinement(), hexRef8::consistentSlowRefinement2(), inversePointDistanceDiffusivity::correct(), cyclicPolyPatch::coupledEdges(), cyclicACMIGAMGInterface::cyclicACMIGAMGInterface(), cyclicAMIGAMGInterface::cyclicAMIGAMGInterface(), topoSet::declareRunTimeSelectionTable(), fvMeshDistribute::distribute(), snappyLayerDriver::doLayers(), snappyRefineDriver::doRefine(), snappySnapDriver::doSnap(), HashTable< T, Key, HashType >::erase(), Foam::eraseImpl(), dynamicIndexedOctree< Type >::findBox(), indexedOctree< Type >::findBox(), dynamicIndexedOctree< Type >::findSphere(), indexedOctree< Type >::findSphere(), Foam::getAcceptableFunctionKeys(), surfaceSets::getHangingCells(), combineFaces::getMergeSets(), cellDistFuncs::getPointNeighbours(), removePoints::getUnrefimentSet(), HashSet< Key, Hash >::HashSet(), HashSet< Key, Hash >::HashSet(), HashSet< Key, Hash >::HashSet(), HashSet< Key, Hash >::HashSet(), HashSet< Key, Hash >::HashSet(), dynamicRefineFvMesh::init(), InjectedParticleDistributionInjection< CloudType >::initialise(), InjectedParticleInjection< CloudType >::initialise(), injectionModelList::injectionModelList(), injectionModelList::injectionModelList(), interfaceDefinitions::interfaceDefinitions(), Foam::interpolatePointToCell(), topoSet::invert(), isoSurfaceTopo::isoSurfaceTopo(), lduPrimitiveMesh::lduPrimitiveMesh(), IOobjectList::lookupClassImpl(), IOobjectList::lookupClassTypeImpl(), IOobjectList::lookupImpl(), polyBoundaryMesh::matchGroups(), meshRefinement::mergeBaffles(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), blockMesh::mesh(), Foam::names_impl(), IOobjectList::namesImpl(), objectRegistry::namesImpl(), IOobjectList::namesTypeImpl(), objectRegistry::namesTypeImpl(), polyBoundaryMesh::neighbourEdges(), topoSet::New(), IOobjectList::objectsTypeImpl(), objectRegistry::objectsTypeImpl(), operator+=(), Foam::operator<<(), HashSet< Key, Hash >::operator==(), operator==(), Foam::polyMeshZipUpCells(), printInfo(), wallBoundedStreamLine::read(), wallShearStress::read(), molecule::readFields(), boundaryMesh::readTriSurface(), refinementSurfaces::refinementSurfaces(), lumpedPointController::remapPointLabels(), structuredRenumber::renumber(), motionSmootherAlgo::scaleMesh(), boundaryCutter::setRefinement(), duplicatePoints::setRefinement(), edgeCollapser::setRefinement(), hexRef8::setRefinement(), removePoints::setRefinement(), hexRef8::setUnrefinement(), rigidBodyMeshMotionSolver::solve(), meshRefinement::splitFacesUndo(), surfaceFeatures::surfaceFeatures(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), topoBitSet::topoBitSet(), topoBitSet::topoBitSet(), topoBitSet::topoBitSet(), topoBoolSet::topoBoolSet(), topoBoolSet::topoBoolSet(), topoBoolSet::topoBoolSet(), wallBoundedStreamLine::track(), transferModelList::transferModelList(), edgeVertex::updateLabels(), topoSet::updateLabels(), liquidFilmBase::Uw(), Foam::HashTableOps::values(), cuttingSurfaceBase::walkCellCuts(), regionSizeDistribution::write(), Foam::writeAllAreaFields(), Foam::writeAllAreaFields(), Foam::writeAllDimFields(), Foam::writeAllDimFields(), Foam::writeAllDimFields(), Foam::writeAllPointFields(), Foam::writeAllPointFields(), Foam::writeAllVolFields(), Foam::writeAllVolFields(), Foam::writeAllVolFields(), topoSet::writeDebug(), topoSet::writeDebug(), molecule::writeFields(), writeKeys(), triSurface::writeStats(), graph::y(), graph::y(), and meshRefinement::zonify().

capacity()

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

label capacity ( ) const

inlinenoexcept

The size of the underlying table (the number of buckets).

Definition at line 363 of file HashTable.H.

Referenced by objectRegistry::lookupClassTypeImpl(), HashSet< Foam::string >::operator()(), and exprResultGlobals::Table::Table().

Here is the caller graph for this function:

at() [1/2]

template<class T, class Key, class Hash>

T & at ( const Key & key )

inline

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

Definition at line 38 of file HashTableI.H.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, find(), HashTable< T, Key, Hash >::Iterator< Const >::good(), Foam::T(), toc(), and HashTable< T, Key, Hash >::iterator::val().

Referenced by operator[](), and operator[]().

Here is the call graph for this function:

Here is the caller graph for this function:

at() [2/2]

template<class T, class Key, class Hash>

const T & at ( const Key & key ) const

inline

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

Definition at line 55 of file HashTableI.H.

References cfind(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, HashTable< T, Key, Hash >::Iterator< Const >::good(), Foam::T(), toc(), and HashTable< T, Key, Hash >::const_iterator::val().

Here is the call graph for this function:

contains()

template<class T, class Key, class Hash>

bool contains ( const Key & key ) const

inline

True if hashed key is contained (found) in table.

Definition at line 72 of file HashTableI.H.

References HashTable< T, Key, Hash >::Iterator< Const >::good().

Referenced by boundaryRadiationProperties::boundaryRadiationProperties(), HashTable< T, Key, HashType >::erase(), HashTable< T, Key, HashType >::found(), topoSet::invert(), merge(), HashSet< Key, Hash >::operator()(), HashSet< Key, Hash >::operator==(), HashSet< Key, Hash >::operator[](), HashSet< Key, Hash >::operator^=(), Foam::printBadEntries(), NASsurfaceFormat< Face >::read(), HashTable< T, Key, HashType >::retain(), Foam::subsetAdjacency(), and HashSet< Key, HashType >::test().

Here is the call graph for this function:

Here is the caller graph for this function:

find() [1/2]

template<class T, class Key, class Hash>

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 85 of file HashTableI.H.

Referenced by triSurfaceMesh::addFaceToEdge(), exprResultGlobals::addValue(), at(), GAMGAgglomeration::calculateRegionMaster(), objectRegistry::checkIn(), objectRegistry::checkOut(), wallDistAddressing::correct(), cyclicPolyPatch::coupledEdges(), HashPtrTable< T, Key, Hash >::erase(), erase(), addPatchCellLayer::findDuplicatedPoints(), polyMeshAdder::findSharedPoints(), FreeStream< CloudType >::FreeStream(), HashPtrTable< T, Key, Hash >::get(), combineFaces::getMergeSets(), snappyLayerDriver::mapFaceZonePoints(), betaMax::markProcessorEdges(), attachDetach::modifyMotionPoints(), slidingInterface::modifyMotionPoints(), polyBoundaryMesh::neighbourEdges(), operator()(), operator()(), HashPtrTable< T, Key, Hash >::release(), HashPtrTable< T, Key, Hash >::remove(), HashPtrTable< T, Key, Hash >::set(), boundaryCutter::setRefinement(), duplicatePoints::setRefinement(), tetDecomposer::setRefinement(), reader::warnDuplicates(), meshReader::warnDuplicates(), and meshRefinement::zonify().

Here is the caller graph for this function:

find() [2/2]

template<class T, class Key, class Hash>

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 101 of file HashTableI.H.

References cfind().

Here is the call graph for this function:

cfind()

template<class T, class Key, class Hash>

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 112 of file HashTableI.H.

Referenced by at(), holeToFace::calcClosure(), createShellMesh::calcPointRegions(), calculatedProcessorGAMGInterface::calculatedProcessorGAMGInterface(), IOobjectList::cfindObject(), cyclicPolyPatch::coupledEdges(), cyclicACMIGAMGInterface::cyclicACMIGAMGInterface(), cyclicAMIGAMGInterface::cyclicAMIGAMGInterface(), cyclicGAMGInterface::cyclicGAMGInterface(), snappyLayerDriver::determineSidePatches(), find(), HashPtrTable< T, Key, Hash >::get(), Foam::inplaceRenumber(), fvMeshSubset::interpolate(), lduPrimitiveMesh::lduPrimitiveMesh(), lookup(), PatchTools::matchEdges(), PatchTools::matchPoints(), globalMeshData::mergePoints(), polyMeshAdder::mergePoints(), blockMesh::mesh(), slidingInterface::modifyMotionPoints(), operator==(), oversetGAMGInterface::oversetGAMGInterface(), PatchTools::pointNormals(), PatchTools::pointNormals(), processorGAMGInterface::processorGAMGInterface(), NASsurfaceFormat< Face >::read(), OBJsurfaceFormat< Face >::read(), STARCDsurfaceFormat< Face >::read(), combineFaces::setUnrefinement(), meshRefinement::splitFacesUndo(), surfaceFeatures::surfaceFeatures(), syncTools::syncEdgeList(), syncTools::syncEdgeMap(), syncTools::syncPointList(), syncTools::syncPointMap(), and HashPtrTable< T, Key, Hash >::test().

Here is the caller graph for this function:

lookup()

template<class T, class Key, class Hash>

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 221 of file HashTableI.H.

References cfind(), HashTable< T, Key, Hash >::Iterator< Const >::good(), Foam::T(), and HashTable< T, Key, Hash >::const_iterator::val().

Referenced by cellTable::addCellZones(), enrichedPatch::calcEnrichedFaces(), addPatchCellLayer::calcExtrudeInfo(), betaMax::markProcessorEdges(), Foam::printDOT(), ABAQUSsurfaceFormat< Face >::read(), UnsortedMeshedSurface< Face >::sortedZones(), Foam::subsetAdjacency(), and cuttingSurfaceBase::walkCellCuts().

Here is the call graph for this function:

Here is the caller graph for this function:

toc()

template<class T, class Key, class Hash>

Foam::List< Key > toc

(

)

const

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

Definition at line 141 of file HashTable.C.

References cbegin(), and cend().

Referenced by IOobjectList::allNames(), at(), at(), cellToCellStencil::calcFaceCells(), cellToFaceStencil::calcFaceCells(), zoneCellStencils::calcFaceCells(), cellTable::combine(), patchDataWave< TransferType, TrackingData >::correct(), meshRefinement::createBaffles(), dynamicIndexedOctree< Type >::findBox(), indexedOctree< Type >::findBox(), dynamicIndexedOctree< Type >::findSphere(), indexedOctree< Type >::findSphere(), cellDistFuncs::getPointNeighbours(), removePoints::getUnrefimentSet(), triSurfaceTools::getVertexVertices(), InflationInjection< CloudType >::InflationInjection(), Foam::MapConsistentSubMesh(), attachDetach::modifyMotionPoints(), IOobjectList::names(), objectRegistry::names(), faceAreaWeightAMI2D::overlappingTgtFaces(), displacementPointSmoothingMotionSolver::relax(), displacementSmartPointSmoothingMotionSolver::relax(), mapDistributeBase::schedule(), hexRef8::setUnrefinement(), displacementPointSmoothingMotionSolver::solve(), displacementSmartPointSmoothingMotionSolver::solve(), sortedToc(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), topoSet::writeDebug(), and Foam::meshTools::writeOBJ().

Here is the call graph for this function:

Here is the caller graph for this function:

sortedToc() [1/3]

template<class T, class Key, class Hash>

Foam::List< Key > sortedToc

(

)

const

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

Definition at line 156 of file HashTable.C.

References Foam::sort(), and toc().

Referenced by singleProcessorFaceSets::add(), cellTable::addCellZones(), cellZoneSet::addSet(), pointZoneSet::addSet(), regionToFace::applyToSet(), PDRblock::blockMeshDict(), faMesh::boundaryProcs(), faPatch::boundaryProcs(), faMesh::boundaryProcSizes(), faPatch::boundaryProcSizes(), holeToFace::calcClosure(), Foam::checkFireEdges(), IOobjectList::checkNames(), edgeMeshFormatsCore::checkSupport(), surfaceFormatsCore::checkSupport(), box::createMap(), snappyRefineDriver::doRefine(), patchFieldProbe::findElements(), Foam::getAcceptableFunctionKeys(), faBoundaryMesh::indices(), faBoundaryMesh::indices(), faBoundaryMesh::indices(), pointBoundaryMesh::indices(), pointBoundaryMesh::indices(), pointBoundaryMesh::indices(), polyBoundaryMesh::indices(), polyBoundaryMesh::indices(), polyBoundaryMesh::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), isoSurfaceTopo::isoSurfaceTopo(), functionObjectList::list(), Foam::listSwitches(), ensightCells::meshPointMap(), noiseFFT::octaveBandInfo(), ParticleErosion< CloudType >::ParticleErosion(), Foam::polyMeshZipUpCells(), Probes< ProbeType >::prepare(), ABAQUSsurfaceFormat< Face >::read(), AMIWeights::read(), fieldExtents::read(), wallShearStress::read(), writeDictionary::read(), refinementSurfaces::refinementSurfaces(), meshRefinement::removeGapCells(), faMeshBoundaryHalo::reset(), cellSetOption::setCellSelection(), noiseModel::setOctaveBands(), IOobjectList::sortedNames(), IOobjectList::sortedNames(), objectRegistry::sortedNames(), Foam::BitOps::sortedToc(), cellZoneSet::subset(), pointZoneSet::subset(), cellZoneSet::sync(), pointZoneSet::sync(), Foam::BitOps::toc(), regionProperties::types(), cuttingSurfaceBase::walkCellCuts(), ensightCase::write(), regionSizeDistribution::write(), and meshRefinement::zonify().

Here is the call graph for this function:

sortedToc() [2/3]

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

template<class Compare>

List< Key > sortedToc

(

const Compare &

comp

)

const

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

tocKeys() [1/2]

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

template<class UnaryPredicate>

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]

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

template<class UnaryPredicate>

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]

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

template<class BinaryPredicate>

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

csorted()

template<class T, class Key, class Hash>

Foam::UPtrList< const typename Foam::HashTable< T, Key, Hash >::node_type > csorted

(

)

const

Const access to the hash-table contents in sorted order (sorted by keys).

The lifetime of the returned content cannot exceed the parent!

Definition at line 181 of file HashTable.C.

References cbegin(), cend(), UPtrList< T >::set(), and Foam::sort().

Referenced by lduPrimitiveMesh::lduPrimitiveMesh(), and HashTable< T, Key, HashType >::sorted().

Here is the call graph for this function:

Here is the caller graph for this function:

sorted() [1/2]

template<class T, class Key, class Hash>

Foam::UPtrList< typename Foam::HashTable< T, Key, Hash >::node_type > sorted

(

)

Non-const access to the hash-table contents in sorted order (sorted by keys).

The lifetime of the returned content cannot exceed the parent!

Definition at line 200 of file HashTable.C.

References begin(), end(), UPtrList< T >::set(), and Foam::sort().

Here is the call graph for this function:

countKeys() [1/2]

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

template<class UnaryPredicate>

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]

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

template<class UnaryPredicate>

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]

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

template<class BinaryPredicate>

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()

template<class T, class Key, class Hash>

template<class... Args>

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 128 of file HashTableI.H.

References args.

Referenced by boundaryRegion::boundaryTypes(), zoneDistribute::getFields(), zoneDistribute::getPositionFields(), cellTable::materialTypes(), merge(), Foam::names_impl(), operator()(), NASsurfaceFormat< Face >::read(), and cellTable::selectType().

Here is the caller graph for this function:

emplace_set()

template<class T, class Key, class Hash>

template<class... Args>

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 140 of file HashTableI.H.

References args.

insert() [1/2]

template<class T, class Key, class Hash>

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 151 of file HashTableI.H.

References Foam::T().

Referenced by triSurfaceMesh::addFaceToEdge(), holeToFace::calcClosure(), addPatchCellLayer::calcExtrudeInfo(), createShellMesh::calcPointRegions(), extractEulerianParticles::calculateAddressing(), calculatedProcessorGAMGInterface::calculatedProcessorGAMGInterface(), GAMGAgglomeration::calculateRegionMaster(), objectRegistry::checkIn(), IOobjectList::classesImpl(), objectRegistry::classesImpl(), cellTable::combine(), hexRef8::consistentSlowRefinement(), patchPatchDist::correct(), cellDistFuncs::correctBoundaryCells(), cellDistFuncs::correctBoundaryFaceCells(), cellDistFuncs::correctBoundaryPointCells(), cyclicPolyPatch::coupledEdges(), multiWorldConnections::createComms(), cyclicACMIGAMGInterface::cyclicACMIGAMGInterface(), cyclicAMIGAMGInterface::cyclicAMIGAMGInterface(), cyclicGAMGInterface::cyclicGAMGInterface(), snappyLayerDriver::determineSidePatches(), snappyRefineDriver::doRefine(), addPatchCellLayer::findDuplicatedPoints(), polyMeshAdder::findSharedPoints(), multiphaseInterSystem::generatePhaseModels(), zoneDistribute::getDatafromOtherProc(), combineFaces::getMergeSets(), leastSquareGrad< T >::grad(), surfaceInterpolate::interpolateFields(), Foam::invertToMap(), triSurfaceLoader::load(), objectRegistry::lookupClassTypeImpl(), faceCoupleInfo::makeMap(), faceCoupleInfo::makeMap(), Foam::MapConsistentSubMesh(), snappyLayerDriver::mapFaceZonePoints(), reconstructedDistanceFunction::markCellsNearSurf(), betaMax::markProcessorEdges(), PatchTools::matchEdges(), meshRefinement::mergePoints(), blockMesh::mesh(), ensightCells::meshPointMap(), surfaceFeatures::nearestEdges(), surfaceFeatures::nearestSamples(), surfaceFeatures::nearestSamples(), polyBoundaryMesh::neighbourEdges(), cellTable::operator=(), oversetGAMGInterface::oversetGAMGInterface(), boundaryMesh::patchify(), processorGAMGInterface::processorGAMGInterface(), NASsurfaceFormat< Face >::read(), OBJsurfaceFormat< Face >::read(), functionObjectList::read(), boundaryMesh::readTriSurface(), meshRefinement::removeGapCells(), boundaryRegion::rename(), forceCoeffs::selectCoeffs(), boundaryCutter::setRefinement(), combineFaces::setRefinement(), edgeCollapser::setRefinement(), faceCollapser::setRefinement(), refinementIterator::setRefinement(), removePoints::setRefinement(), tetDecomposer::setRefinement(), combineFaces::setUnrefinement(), UnsortedMeshedSurface< Face >::sortedZones(), surfaceFeatures::surfaceFeatures(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), dynamicRefineFvMesh::unrefine(), edgeVertex::updateLabels(), boundaryCutter::updateMesh(), localPointRegion::updateMesh(), meshCutAndRemove::updateMesh(), meshCutter::updateMesh(), meshRefinement::updateMesh(), cuttingSurfaceBase::walkCellCuts(), wallLayerCells::wallLayerCells(), reader::warnDuplicates(), meshReader::warnDuplicates(), OBJstream::write(), coupledPolyPatch::writeOBJ(), Foam::meshTools::writeOBJ(), streamLineBase::writeToFile(), and meshRefinement::zonify().

Here is the call graph for this function:

insert() [2/2]

template<class T, class Key, class Hash>

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 162 of file HashTableI.H.

References Foam::T().

Here is the call graph for this function:

set() [1/2]

template<class T, class Key, class Hash>

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 173 of file HashTableI.H.

References Foam::T().

Referenced by interfaceDefinitions::add(), edgeCollapser::markSmallEdges(), operator=(), NASedgeFormat::read(), STARCDedgeFormat::read(), and syncTools::syncPointMap().

Here is the call graph for this function:

Here is the caller graph for this function:

set() [2/2]

template<class T, class Key, class Hash>

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 184 of file HashTableI.H.

References Foam::T().

Here is the call graph for this function:

erase() [1/10]

template<class T, class Key, class Hash>

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 489 of file HashTable.C.

Referenced by fileOperation::addWatches(), masterUncollatedFileOperation::addWatches(), faMesh::boundaryProcs(), faPatch::boundaryProcs(), faMesh::boundaryProcSizes(), faPatch::boundaryProcSizes(), cellTable::combine(), objectRegistry::erase(), ddt2::execute(), zeroGradient::execute(), cellDistFuncs::getPointNeighbours(), polyBoundaryMesh::matchGroups(), merge(), Probes< ProbeType >::prepare(), ensightSurfaceReader::readCase(), refinementSurfaces::refinementSurfaces(), faceCollapser::setRefinement(), perfectInterface::setRefinement(), HashSet< Key, HashType >::unset(), cuttingSurfaceBase::walkCellCuts(), and regionSizeDistribution::write().

Here is the caller graph for this function:

erase() [2/10]

template<class T, class Key, class Hash>

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 501 of file HashTable.C.

References find(), and HashTable< T, Key, Hash >::Iterator< Const >::good().

Here is the call graph for this function:

erase() [3/10]

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

template<class AnyType, class AnyHash>

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]

template<class T, class Key, class Hash>

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 540 of file HashTable.C.

References erase(), and keys().

Here is the call graph for this function:

erase() [5/10]

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

template<class InputIter>

label erase ( InputIter first, InputIter last )

inline

Remove multiple entries using an iterator range of keys.

erase() [6/10]

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

template<unsigned N>

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]

template<class T, class Key, class Hash>

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 561 of file HashTable.C.

References erase(), and keys().

Here is the call graph for this function:

retain() [1/2]

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

template<class AnyType, class AnyHash>

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]

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

template<class UnaryPredicate>

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)

Referenced by IOobjectList::prune_0().

Here is the caller graph for this function:

filterValues() [1/2]

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

template<class UnaryPredicate>

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]

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

template<class BinaryPredicate>

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)

clear()

template<class T, class Key, class Hash>

void clear

(

)

Remove all entries from table.

Definition at line 742 of file HashTable.C.

Referenced by polyMeshTetDecomposition::adjustTetBasePtIs(), Foam::calcCellCellsImpl(), addPatchCellLayer::calcExtrudeInfo(), cellToCellStencil::calcFaceCells(), cellToFaceStencil::calcFaceCells(), zoneCellStencils::calcFaceCells(), cellToFaceStencil::calcFaceStencil(), primitiveMesh::checkFaceFaces(), objectRegistry::clear(), cellSet::distribute(), faceSet::distribute(), pointSet::distribute(), dynamicIndexedOctree< Type >::findBox(), indexedOctree< Type >::findBox(), addPatchCellLayer::findDuplicatedPoints(), dynamicIndexedOctree< Type >::findSphere(), indexedOctree< Type >::findSphere(), interfaceDefinitions::interfaceDefinitions(), triSurfaceLoader::load(), cellTable::operator=(), NASedgeFormat::read(), NASsurfaceFormat< Face >::read(), STARCDedgeFormat::read(), STARCDsurfaceFormat< Face >::read(), wallBoundedStreamLine::read(), displacementPointSmoothingMotionSolver::relax(), displacementSmartPointSmoothingMotionSolver::relax(), Foam::resetFuncsImpl(), tetDecomposer::setRefinement(), meshRefinement::splitFacesUndo(), surfaceFeatures::surfaceFeatures(), and cuttingSurfaceBase::walkCellCuts().

Here is the caller graph for this function:

clearStorage()

template<class T, class Key, class Hash>

void clearStorage

(

)

Remove all entries from table and the table itself.

Equivalent to clear() followed by setCapacity(0)

Definition at line 767 of file HashTable.C.

Referenced by objectRegistry::clearStorage(), cellZoneSet::updateSet(), faceZoneSet::updateSet(), and pointZoneSet::updateSet().

Here is the caller graph for this function:

setCapacity()

template<class T, class Key, class Hash>

void setCapacity

(

label

newCapacity

)

Change the hash table capacity (number of buckets).

Setting a zero capacity will only remove the underlying storage if the table is empty.

Definition at line 652 of file HashTable.C.

References HashTableCore::canonicalSize(), Foam::nl, and WarningInFunction.

Referenced by resize().

Here is the call graph for this function:

Here is the caller graph for this function:

resize()

template<class T, class Key, class Hash>

void resize

(

label

newCapacity

)

Rehash the hash table with new number of buckets. Currently identical to setCapacity().

Definition at line 722 of file HashTable.C.

References setCapacity().

Referenced by HeatTransferCoeff< CloudType >::postEvolve(), and NusseltNumber< CloudType >::postEvolve().

Here is the call graph for this function:

Here is the caller graph for this function:

reserve()

template<class T, class Key, class Hash>

void reserve

(

label

numEntries

)

Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table.

Definition at line 729 of file HashTable.C.

Referenced by cellTable::addCellZones(), boundaryRegion::boundaryTypes(), zone::checkDefinition(), IOobjectList::classesImpl(), objectRegistry::classesImpl(), wallDistAddressing::correct(), cellSet::distribute(), faceSet::distribute(), pointSet::distribute(), dynamicIndexedOctree< Type >::findBox(), indexedOctree< Type >::findBox(), dynamicIndexedOctree< Type >::findSphere(), indexedOctree< Type >::findSphere(), Foam::getAcceptableFunctionKeys(), HashTable(), HashTable(), faBoundaryMesh::indices(), faBoundaryMesh::indices(), faBoundaryMesh::indices(), pointBoundaryMesh::indices(), pointBoundaryMesh::indices(), polyBoundaryMesh::indices(), polyBoundaryMesh::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), ZoneMesh< ZoneType, MeshType >::indices(), Foam::invertToMap(), IOobjectList::IOobjectList(), isoSurfaceTopo::isoSurfaceTopo(), cellTable::materialTypes(), Foam::names_impl(), processorTopology::New(), polyBoundaryMesh::patchSet(), boundaryRegion::rename(), cellTable::selectType(), edgeCollapser::setRefinement(), removePoints::setRefinement(), syncTools::syncPointMap(), cellZoneSet::updateSet(), faceZoneSet::updateSet(), pointZoneSet::updateSet(), and Foam::HashSetOps::used().

Here is the caller graph for this function:

swap()

template<class T, class Key, class Hash>

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

noexcept

Swap contents into this table.

Definition at line 780 of file HashTable.C.

References HashTable(), and Foam::rhs().

Referenced by transfer().

Here is the call graph for this function:

Here is the caller graph for this function:

transfer()

template<class T, class Key, class Hash>

void transfer

(

HashTable< T, Key, Hash > &

rhs

)

Transfer contents into this table.

Definition at line 794 of file HashTable.C.

References clear(), HashTable(), Foam::rhs(), and swap().

Referenced by primitiveMesh::checkEdgeLength(), FreeStream< CloudType >::FreeStream(), polyBoundaryMesh::matchGroups(), IOobjectList::operator=(), HashPtrTable< IOobject >::remove(), and topoSet::updateLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

merge() [1/2]

template<class T, class Key, class Hash>

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.

Definition at line 888 of file HashTable.C.

References begin(), contains(), emplace(), end(), erase(), HashTable(), and HashTable< T, Key, Hash >::Iterator< Const >::key().

Referenced by merge().

Here is the call graph for this function:

Here is the caller graph for this function:

merge() [2/2]

template<class T, class Key, class Hash>

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.

Definition at line 921 of file HashTable.C.

References HashTable(), and merge().

Here is the call graph for this function:

operator[]() [1/2]

template<class T, class Key, class Hash>

T & operator[] ( const Key & key )

inline

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

Same as at().

Definition at line 235 of file HashTableI.H.

References at(), and Foam::T().

Here is the call graph for this function:

operator[]() [2/2]

template<class T, class Key, class Hash>

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

inline

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

Same as at().

Definition at line 242 of file HashTableI.H.

References at(), and Foam::T().

Here is the call graph for this function:

operator()() [1/2]

template<class T, class Key, class Hash>

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 249 of file HashTableI.H.

References emplace(), find(), HashTable< T, Key, Hash >::Iterator< Const >::good(), Foam::T(), and HashTable< T, Key, Hash >::iterator::val().

Here is the call graph for this function:

operator()() [2/2]

template<class T, class Key, class Hash>

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

inline

Return existing entry or insert a new entry.

Definition at line 264 of file HashTableI.H.

References find(), HashTable< T, Key, Hash >::Iterator< Const >::good(), insert(), Foam::T(), and HashTable< T, Key, Hash >::iterator::val().

Here is the call graph for this function:

operator=() [1/3]

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

void operator=

(

const this_type &

rhs

)

Copy assign.

operator=() [2/3]

template<class T, class Key, class Hash>

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 951 of file HashTable.C.

References clear(), operator, reserve(), Foam::rhs(), and set().

Here is the call graph for this function:

operator=() [3/3]

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

void operator=

(

this_type &&

rhs

)

Move assign.

operator==()

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

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 977 of file HashTable.C.

References cfind(), HashTable< T, Key, Hash >::Iterator< Const >::good(), HashTable(), HashTable< T, Key, Hash >::Iterator< Const >::key(), operator, Foam::rhs(), size(), HashTable< T, Key, Hash >::const_iterator::val(), and HashTable< T, Key, Hash >::iterator::val().

Here is the call graph for this function:

operator!=()

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

bool operator!=

(

const this_type &

rhs

)

const

The opposite of the equality operation.

Definition at line 1003 of file HashTable.C.

References HashTable(), operator, Foam::operator==(), and Foam::rhs().

Here is the call graph for this function:

operator+=()

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

Foam::HashTable< T, Key, Hash > & operator+=

(

const this_type &

rhs

)

Add entries into this HashTable.

Definition at line 1013 of file HashTable.C.

References HashTable(), insert(), HashTable< T, Key, Hash >::Iterator< Const >::key(), operator, Foam::rhs(), size(), and HashTable< T, Key, Hash >::iterator::val().

Here is the call graph for this function:

keys()

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

const_iterator_pair< const_key_iterator, this_type > keys ( ) const

inline

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

Definition at line 1295 of file HashTable.H.

Referenced by erase(), erase(), HashTable(), and Map< interfaceEntry >::Map().

Here is the caller graph for this function:

begin() [1/2]

template<class T, class Key, class Hash>

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

inline

iterator set to the beginning of the HashTable

Definition at line 167 of file HashTableIterI.H.

Referenced by HashPtrTable< T, Key, Hash >::clear(), IOobjectList::filterClasses(), IOobjectList::filterObjects(), Foam::kShellIntegration(), merge(), sorted(), graph::y(), and graph::y().

Here is the caller graph for this function:

begin() [2/2]

template<class T, class Key, class Hash>

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

inline

const_iterator set to the beginning of the HashTable

Definition at line 175 of file HashTableIterI.H.

cbegin()

template<class T, class Key, class Hash>

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

inline

const_iterator set to the beginning of the HashTable

Definition at line 183 of file HashTableIterI.H.

Referenced by csorted(), HashTable< T, Key, HashType >::erase(), multiphaseInterSystem::generatePhi(), HashSet< Key, Hash >::HashSet(), multivariateScheme< Type, Scheme >::multivariateScheme(), multivariateSelectionScheme< Type >::multivariateSelectionScheme(), exprResultGlobals::Table::Table(), toc(), regionSizeDistribution::write(), HashPtrTable< T, Key, Hash >::write(), and writeKeys().

Here is the caller graph for this function:

end() [1/2]

template<class T, class Key, class Hash>

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

inlinenoexcept

iterator to signal the end (for any HashTable)

Definition at line 191 of file HashTableIterI.H.

References Foam::noexcept.

Referenced by HashPtrTable< T, Key, Hash >::clear(), IOobjectList::filterClasses(), IOobjectList::filterObjects(), merge(), duplicatePoints::setRefinement(), tetDecomposer::setRefinement(), and sorted().

Here is the caller graph for this function:

end() [2/2]

template<class T, class Key, class Hash>

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

inlinenoexcept

const_iterator to signal the end (for any HashTable)

Definition at line 199 of file HashTableIterI.H.

References Foam::noexcept.

cend()

template<class T, class Key, class Hash>

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

inlineconstexprnoexcept

const_iterator to signal the end (for any HashTable)

Definition at line 207 of file HashTableIterI.H.

References Foam::noexcept.

Referenced by csorted(), HashTable< T, Key, HashType >::erase(), multiphaseInterSystem::generatePhi(), HashSet< Key, Hash >::HashSet(), exprResultGlobals::Table::Table(), toc(), HashPtrTable< T, Key, Hash >::write(), and writeKeys().

Here is the caller graph for this function:

printInfo()

template<class T, class Key, class Hash>

Foam::Ostream & printInfo

(

Ostream &

os

)

const

Print information.

Definition at line 40 of file HashTableIO.C.

References Foam::endl(), os(), and size().

Here is the call graph for this function:

writeKeys()

template<class T, class Key, class Hash>

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 76 of file HashTableIO.C.

References token::BEGIN_LIST, cbegin(), cend(), token::END_LIST, FUNCTION_NAME, Foam::nl, os(), size(), and token::SPACE.

Referenced by HashSet< Key, HashType >::writeList().

Here is the call graph for this function:

Here is the caller graph for this function:

found()

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

bool found ( const Key & key ) const

inline

Same as contains().

Definition at line 1370 of file HashTable.H.

Referenced by topOVariablesBase::addBoundaryFacesToIsoline(), phaseSystem::addField(), snappyLayerDriver::addLayers(), snappyLayerDriver::addLayersSinglePass(), exprResultGlobals::addValue(), layerAdditionRemoval::changeTopology(), edgeMeshFormatsCore::checkSupport(), surfaceFormatsCore::checkSupport(), ABAQUSCore::readHelper::compact_nodes(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), patchPatchDist::correct(), cellDistFuncs::correctBoundaryCells(), motionSmootherAlgo::correctBoundaryConditions(), cellDistFuncs::correctBoundaryPointCells(), curvatureSeparation::curvatureSeparation(), hexCellLooper::cut(), Foam::meshTools::cutDirToEdge(), snappyLayerDriver::dupFaceZonePoints(), parseDriver::field_cellSelection(), parseDriver::field_faceSelection(), surfaceSets::getHangingCells(), cellDistFuncs::getPointNeighbours(), removePoints::getUnrefimentSet(), oversetFvPatchField< Type >::initEvaluate(), cellCellStencil::interpolate(), surfaceInterpolate::interpolateFields(), cellFeatures::isFeatureEdge(), BlendedInterfacialModel< Foam::dragModel >::Kf(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::massTransfer(), MeshedSurface< Face >::New(), UnsortedMeshedSurface< Face >::New(), orderedPhasePair::orderedPhasePair(), InflationInjection< CloudType >::parcelsToInject(), boundaryMesh::patchify(), STARCDMeshReader::readBoundary(), motionSmootherAlgo::setDisplacementPatchFields(), boundaryCutter::setRefinement(), refinementIterator::setRefinement(), meshRefinement::splitFacesUndo(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), faMesh::updateMesh(), cuttingSurfaceBase::walkCellCuts(), wallLayerCells::wallLayerCells(), regionSizeDistribution::write(), MeshedSurface< Face >::write(), and UnsortedMeshedSurface< Face >::write().

Here is the caller graph for this function:

sorted() [2/2]

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

UPtrList< const node_type > sorted ( ) const

inline

Deprecated(2023-07) use csorted() method.

Deprecated

(2023-07) - use csorted() method

Definition at line 1378 of file HashTable.H.

sortedToc() [3/3]

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

template<class Compare>

Foam::List< Key > sortedToc

(

const Compare &

comp

)

const

Definition at line 167 of file HashTable.C.

Referenced by multiWorldConnections::createComms(), DispersionRASModel< CloudType >::epsilonModel(), DispersionRASModel< CloudType >::kModel(), and Foam::printDOT().

Here is the caller graph for this function:

tocKeys() [2/2]

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

template<class UnaryPredicate>

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

Definition at line 220 of file HashTable.C.

tocValues() [2/2]

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

template<class UnaryPredicate>

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

Definition at line 246 of file HashTable.C.

tocEntries() [2/2]

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

template<class BinaryPredicate>

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

Definition at line 272 of file HashTable.C.

countKeys() [2/2]

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

template<class UnaryPredicate>

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

Definition at line 298 of file HashTable.C.

countValues() [2/2]

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

template<class UnaryPredicate>

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

Definition at line 320 of file HashTable.C.

countEntries() [2/2]

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

template<class BinaryPredicate>

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

Definition at line 342 of file HashTable.C.

erase() [8/10]

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

template<class InputIter>

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

inline

Definition at line 514 of file HashTable.C.

Referenced by cyclicPolyPatch::coupledEdges(), and polyBoundaryMesh::neighbourEdges().

Here is the caller graph for this function:

erase() [9/10]

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

template<unsigned N>

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

inline

Definition at line 551 of file HashTable.C.

erase() [10/10]

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

template<class AnyType, class AnyHash>

Foam::label erase

(

const HashTable< AnyType, Key, AnyHash > &

other

)

Definition at line 572 of file HashTable.C.

retain() [2/2]

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

template<class AnyType, class AnyHash>

Foam::label retain

(

const HashTable< AnyType, Key, AnyHash > &

other

)

Definition at line 620 of file HashTable.C.

filterKeys() [2/2]

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

template<class UnaryPredicate>

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

Definition at line 808 of file HashTable.C.

filterValues() [2/2]

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

template<class UnaryPredicate>

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

Definition at line 835 of file HashTable.C.

filterEntries() [2/2]

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

template<class BinaryPredicate>

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

Definition at line 862 of file HashTable.C.

Friends And Related Symbol Documentation

Iterator< true >

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

friend class Iterator< true >

friend

Allow iterator access to HashTable internals.

Definition at line 839 of file HashTable.H.

Iterator< false >

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

friend class Iterator< false >

friend

Allow iterator access to HashTable internals.

Definition at line 839 of file HashTable.H.

operator>>

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

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

friend

Referenced by HashTable().

operator

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

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

friend

Referenced by HashTable< T, Key, Hash >::Iterator< Const >::operator const Iterator< Any > &(), operator!=(), operator+=(), operator=(), and operator==().

---

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