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

Inherits HashTableCore.

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

[legend]

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 std::conditional< std::is_same< Foam::zero, typename std::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More...

typedef Key	key_type
	The second template parameter, type of keys used. More...

typedef T	mapped_type
	The first template parameter, type of objects contained. More...

typedef T	value_type
	Same as mapped_type for OpenFOAM HashTables. More...

typedef Hash	hasher
	The third template parameter, the hash index method. More...

typedef T *	pointer
	Pointer type for storing into value_type objects. More...

typedef T &	reference
	Reference to the stored value_type. More...

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

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

typedef label	difference_type
	The type to represent the difference between two iterators. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

using	key_iterator = key_iterator_base< iterator >
	Forward iterator returning the key. More...

using	const_key_iterator = key_iterator_base< const_iterator >
	Forward const iterator returning the key. More...

Public Member Functions
	HashTable () noexcept
	Default construct: empty without allocation (capacity=0) More...

	HashTable (const Foam::zero) noexcept
	Construct empty without allocation (capacity=0) More...

	HashTable (const label initialCapacity)
	Construct empty with initial table capacity. More...

	HashTable (Istream &is)
	Construct from Istream. More...

	HashTable (const this_type &ht)
	Copy construct. More...

	HashTable (this_type &&rhs) noexcept
	Move construct. More...

	HashTable (std::initializer_list< std::pair< Key, T >> list, const bool overwrite=false)
	Construct from key/value pairs in initializer list. More...

	HashTable (const UList< Key > &keys, const UList< T > &values, const bool overwrite=false)
	Construct from key/value pairs. More...

	~HashTable ()
	Destructor. More...

bool	empty () const noexcept
	True if the hash table is empty. More...

label	size () const noexcept
	The number of elements in table. More...

label	capacity () const noexcept
	The size of the underlying table (the number of buckets) More...

T &	at (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

bool	contains (const Key &key) const
	True if hashed key is contained (found) in table. More...

iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry. More...

const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...

const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...

const T &	lookup (const Key &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default. More...

List< Key >	toc () const
	The table of contents (the keys) in unsorted order. More...

List< Key >	sortedToc () const
	The table of contents (the keys) in sorted order. More...

template<class Compare >
List< Key >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator. More...

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. More...

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. More...

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. More...

UPtrList< const node_type >	csorted () const
	Const access to the hash-table contents in sorted order (sorted by keys). More...

UPtrList< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys). More...

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	clear ()
	Remove all entries from table. More...

void	clearStorage ()
	Remove all entries from table and the table itself. More...

void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets). More...

void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...

void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...

void	swap (HashTable< T, Key, Hash > &rhs) noexcept
	Swap contents into this table. More...

void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table. More...

void	merge (HashTable< T, Key, Hash > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

void	merge (HashTable< T, Key, Hash > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

T &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

T &	operator() (const Key &key)
	Return existing entry or create a new entry. More...

T &	operator() (const Key &key, const T &deflt)
	Return existing entry or insert a new entry. More...

void	operator= (const this_type &rhs)
	Copy assign. More...

void	operator= (std::initializer_list< std::pair< Key, T >> rhs)
	Copy assign from an initializer list. More...

void	operator= (this_type &&rhs)
	Move assign. More...

bool	operator== (const this_type &rhs) const
	Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More...

bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation. More...

this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable. More...

const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys. More...

iterator	begin ()
	iterator set to the beginning of the HashTable More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

iterator	end () noexcept
	iterator to signal the end (for any HashTable) More...

const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable) More...

constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable) More...

Ostream &	printInfo (Ostream &os) const
	Print information. More...

Ostream &	writeKeys (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen. More...

bool	found (const Key &key) const
	Same as contains() More...

UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method. More...

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) More...

	HashTableCore () noexcept=default
	Default construct. More...

Friends
class	Iterator< true >
	Allow iterator access to HashTable internals. More...

class	Iterator< false >
	Allow iterator access to HashTable internals. More...

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 requested_size)
	Return a canonical (power-of-two) of the requested size. More...

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable internal table size. Approximately labelMax/4. More...

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

Definition at line 108 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 132 of file HashTable.H.

◆ node_type

typedef std::conditional< std::is_same<Foam::zero, typename std::remove_cv<T>::type>::value, Detail::HashTableSingle<Key>, Detail::HashTablePair<Key, T> >::type node_type

A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions.

Definition at line 143 of file HashTable.H.

◆ key_type

typedef Key key_type

The second template parameter, type of keys used.

Definition at line 151 of file HashTable.H.

◆ mapped_type

typedef T mapped_type

The first template parameter, type of objects contained.

Definition at line 156 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 163 of file HashTable.H.

◆ hasher

typedef Hash hasher

The third template parameter, the hash index method.

Definition at line 168 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 175 of file HashTable.H.

◆ reference

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

typedef const T* const_pointer

Const pointer type for the stored value_type.

Definition at line 187 of file HashTable.H.

◆ const_reference

typedef const T& const_reference

Const reference to the stored value_type.

Definition at line 192 of file HashTable.H.

◆ difference_type

typedef label difference_type

The type to represent the difference between two iterators.

Definition at line 197 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 1285 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 1290 of file HashTable.H.

Constructor & Destructor Documentation

◆ HashTable() [1/8]

HashTable ( )

noexcept

Default construct: empty without allocation (capacity=0)

Definition at line 33 of file HashTable.C.

◆ HashTable() [2/8]

HashTable ( const Foam::zero )

explicitnoexcept

Construct empty without allocation (capacity=0)

Definition at line 43 of file HashTable.C.

◆ HashTable() [3/8]

HashTable ( const label initialCapacity )

explicit

Construct empty with initial table capacity.

Definition at line 50 of file HashTable.C.

◆ HashTable() [4/8]

HashTable ( Istream & is )

Construct from Istream.

Definition at line 29 of file HashTableIO.C.

◆ HashTable() [5/8]

HashTable ( const this_type & ht )

Copy construct.

◆ HashTable() [6/8]

HashTable ( this_type && rhs )

noexcept

Move construct.

◆ HashTable() [7/8]

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

◆ HashTable() [8/8]

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

◆ ~HashTable()

~HashTable ( )

Destructor.

Definition at line 133 of file HashTable.C.

Member Function Documentation

◆ empty()

bool empty ( ) const

inlinenoexcept

True if the hash table is empty.

Definition at line 353 of file HashTable.H.

Referenced by interfaceDefinitions::empty(), exprDriver::hasContextObjects(), faBoundaryMesh::indices(), ZoneMesh< cellZone, polyMesh >::indices(), polyBoundaryMesh::indices(), faMeshTools::newMesh(), probes::prepare(), argList::printMan(), wallHeatFlux::read(), wallShearStress::read(), lumpedPointMovement::readDict(), HashTable< const regIOobject * >::retain(), lumpedPointMovement::setInterpolator(), lumpedPointMovement::setPatchControl(), and globalIndexAndTransform::transformIndicesForPatches().

Here is the caller graph for this function:

◆ size()

label size ( ) const

inlinenoexcept

The number of elements in table.

Definition at line 358 of file HashTable.H.

Referenced by oversetFvMeshBase::active(), assemblyFaceAreaPairGAMGAgglomeration::assemblyFaceAreaPairGAMGAgglomeration(), faPatch::boundaryProcSizes(), faMesh::boundaryProcSizes(), cellToFaceStencil::calcFaceStencil(), extractEulerianParticles::calculateAddressing(), pointMVCWeight::calcWeights(), boundaryMesh::changeFaces(), primitiveMesh::checkEdgeLength(), Foam::checkFireEdges(), motionSmootherAlgo::checkMesh(), edgeCollapser::checkMeshQuality(), IOobjectList::classesImpl(), objectRegistry::classesImpl(), coalCloudList::coalCloudList(), hexRef8::consistentSlowRefinement2(), cyclicPolyPatch::coupledEdges(), multiLevelDecomp::decompose(), faMeshDecomposition::decomposeMesh(), faMeshDistributor::distribute(), fvMeshDistribute::distribute(), snappyRefineDriver::doRefine(), HashTable< const regIOobject * >::erase(), Foam::eraseImpl(), runTimeControl::execute(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findBox(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findBox(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findSphere(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findSphere(), Foam::getAcceptableFunctionKeys(), surfaceSets::getHangingCells(), combineFaces::getMergeSets(), removePoints::getUnrefimentSet(), dynamicRefineFvMesh::init(), InjectedParticleInjection< CloudType >::initialise(), InjectedParticleDistributionInjection< CloudType >::initialise(), topoSet::invert(), isoSurfaceTopo::isoSurfaceTopo(), IOobjectList::lookupClassImpl(), IOobjectList::lookupClassTypeImpl(), IOobjectList::lookupImpl(), meshRefinement::mergeBaffles(), meshRefinement::mergePatchFacesUndo(), blockMesh::mesh(), IOobjectList::namesImpl(), objectRegistry::namesImpl(), IOobjectList::namesTypeImpl(), objectRegistry::namesTypeImpl(), IOobjectList::objectsTypeImpl(), objectRegistry::objectsTypeImpl(), Foam::operator<<(), boundaryMesh::patchify(), Foam::polyMeshZipUpCells(), wallHeatFlux::read(), wallShearStress::read(), molecule::readFields(), boundaryMesh::readTriSurface(), lumpedPointController::remapPointLabels(), structuredRenumber::renumber(), vtuSizing::reset(), motionSmootherAlgo::scaleMesh(), lumpedPointMovement::setInterpolator(), lumpedPointMovement::setPatchControl(), duplicatePoints::setRefinement(), removePoints::setRefinement(), hexRef8::setUnrefinement(), interfaceDefinitions::size(), sensitivitySurface::smoothSensitivities(), syncTools::syncEdgeMap(), transferModelList::transferModelList(), Foam::unitSet(), edgeVertex::updateLabels(), Foam::HashTableOps::values(), cuttingSurfaceBase::walkCellCuts(), molecule::writeFields(), triSurface::writeStats(), and meshRefinement::zonify().

◆ capacity()

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

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

◆ contains()

bool contains ( const Key & key ) const

inline

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

Definition at line 72 of file HashTableI.H.

Referenced by boundaryRadiationProperties::boundaryRadiationProperties(), topoSet::contains(), HashTable< const regIOobject * >::erase(), topoSet::found(), HashTable< const regIOobject * >::found(), topoSet::invert(), Foam::printBadEntries(), HashTable< const regIOobject * >::retain(), and Foam::subsetAdjacency().

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

Referenced by triSurfaceMesh::addFaceToEdge(), exprResultGlobals::addValue(), objectRegistry::checkIn(), objectRegistry::checkOut(), wallDistAddressing::correct(), cyclicPolyPatch::coupledEdges(), faMeshDecomposition::decomposeMesh(), FreeStream< CloudType >::FreeStream(), attachDetach::modifyMotionPoints(), slidingInterface::modifyMotionPoints(), duplicatePoints::setRefinement(), tetDecomposer::setRefinement(), addPatchCellLayer::setRefinement(), meshReader::warnDuplicates(), reader::warnDuplicates(), and meshRefinement::zonify().

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

Referenced by STLAsciiParse::beginSolid(), cyclicACMIGAMGInterface::cyclicACMIGAMGInterface(), cyclicAMIGAMGInterface::cyclicAMIGAMGInterface(), runTimeControl::execute(), Foam::stringOps::inplaceExpand(), Foam::inplaceRenumber(), PatchTools::matchPoints(), polyMeshAdder::mergePoints(), globalMeshData::mergePoints(), blockMesh::mesh(), slidingInterface::modifyMotionPoints(), oversetGAMGInterface::oversetGAMGInterface(), PatchTools::pointNormals(), argList::printCompat(), OBJsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), lumpedPointMovement::setInterpolator(), lumpedPointMovement::setPatchControl(), meshRefinement::splitFacesUndo(), syncTools::syncEdgeList(), syncTools::syncEdgeMap(), and syncTools::syncPointList().

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

Referenced by cellTable::addCellZones(), enrichedPatch::calcEnrichedFaces(), addPatchCellLayer::calcExtrudeInfo(), faMeshDistributor::distribute(), processorTopology::procPatchLookup(), Foam::subsetAdjacency(), and 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 148 of file HashTable.C.

Referenced by cellToCellStencil::calcFaceCells(), cellToFaceStencil::calcFaceCells(), zoneCellStencils::calcFaceCells(), patchDataWave< TransferType, TrackingData >::correct(), meshRefinement::createBaffles(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findBox(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findBox(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findSphere(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findSphere(), triSurfaceTools::getVertexVertices(), InflationInjection< CloudType >::InflationInjection(), Foam::MapConsistentSubMesh(), attachDetach::modifyMotionPoints(), objectRegistry::names(), faceAreaWeightAMI2D::overlappingTgtFaces(), mapDistributeBase::schedule(), uniformInterpolatedDisplacementPointPatchVectorField::updateCoeffs(), faGlobalMeshData::updateMesh(), and zoneMotion::zoneMotion().

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

Referenced by regionToFace::applyToSet(), PDRblock::blockMeshDict(), faPatch::boundaryProcs(), faMesh::boundaryProcs(), faPatch::boundaryProcSizes(), faMesh::boundaryProcSizes(), holeToFace::calcClosure(), Foam::checkFireEdges(), edgeMeshFormatsCore::checkSupport(), surfaceFormatsCore::checkSupport(), box::createMap(), faMeshDecomposition::decomposeMesh(), faMeshDistributor::distribute(), snappyRefineDriver::doRefine(), DispersionRASModel< CloudType >::epsilonModel(), patchProbes::findElements(), Foam::getAcceptableFunctionKeys(), faBoundaryMesh::indices(), ZoneMesh< cellZone, polyMesh >::indices(), polyBoundaryMesh::indices(), isoSurfaceTopo::isoSurfaceTopo(), DispersionRASModel< CloudType >::kModel(), functionObjectList::list(), Foam::listSwitches(), ensightCells::meshPointMap(), regionProperties::names(), ParticleErosion< CloudType >::ParticleErosion(), Foam::polyMeshZipUpCells(), probes::prepare(), ABAQUSsurfaceFormat< Face >::read(), writeDictionary::read(), heatTransferCoeffModel::read(), wallHeatFlux::read(), AMIWeights::read(), wallShearStress::read(), lumpedPointMovement::readDict(), meshRefinement::removeGapCells(), faMeshBoundaryHalo::reset(), cellSetOption::setCellSelection(), lumpedPointMovement::setInterpolator(), lumpedPointMovement::setPatchControl(), objectRegistry::sortedNames(), DictionaryBase< DLPtrList< T >, T >::sortedToc(), Foam::BitOps::sortedToc(), DictionaryBase< DLPtrList< T >, T >::toc(), Foam::BitOps::toc(), cuttingSurfaceBase::walkCellCuts(), ensightCase::write(), regionSizeDistribution::write(), Foam::vtk::writeCellSetFaces(), and meshRefinement::zonify().

◆ 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

◆ csorted()

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

Referenced by HashTable< const regIOobject * >::sorted().

Here is the caller graph for this function:

◆ sorted() [1/2]

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

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

Referenced by Pstream::exchangeSizes().

Here is the caller graph for this function:

◆ 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 141 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 152 of file HashTableI.H.

Referenced by triSurfaceMesh::addFaceToEdge(), DictionaryBase< DLPtrList< T >, T >::addHashEntry(), STLAsciiParse::beginSolid(), addPatchCellLayer::calcExtrudeInfo(), extractEulerianParticles::calculateAddressing(), objectRegistry::checkIn(), patchPatchDist::correct(), cellDistFuncs::correctBoundaryFaceCells(), cellDistFuncs::correctBoundaryPointCells(), cyclicPolyPatch::coupledEdges(), faMeshDecomposition::decomposeMesh(), polyMeshAdder::findSharedPoints(), multiphaseInterSystem::generatePhaseModels(), zoneDistribute::getDatafromOtherProc(), surfaceInterpolate::interpolateFields(), Foam::invertToMap(), triSurfaceLoader::load(), Foam::MapConsistentSubMesh(), meshRefinement::mergePoints(), blockMesh::mesh(), ensightCells::meshPointMap(), cellTable::operator=(), OBJsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), functionObjectList::read(), lumpedPointMovement::readDict(), boundaryMesh::readTriSurface(), hashedWordList::rehash(), meshRefinement::removeGapCells(), forceCoeffs::selectCoeffs(), removePoints::setRefinement(), combineFaces::setRefinement(), tetDecomposer::setRefinement(), addPatchCellLayer::setRefinement(), combineFaces::setUnrefinement(), cuttingSurfaceBase::walkCellCuts(), meshReader::warnDuplicates(), reader::warnDuplicates(), Foam::vtk::writeCellSetFaces(), streamLineBase::writeToFile(), 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 163 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 174 of file HashTableI.H.

Referenced by interfaceDefinitions::add(), fvMeshDistribute::distribute(), NASedgeFormat::read(), and STARCDedgeFormat::read().

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

Referenced by masterUncollatedFileOperation::addWatches(), fileOperation::addWatches(), faPatch::boundaryProcs(), faMesh::boundaryProcs(), faPatch::boundaryProcSizes(), faMesh::boundaryProcSizes(), cyclicPolyPatch::coupledEdges(), objectRegistry::erase(), zeroGradient::execute(), ddt2::execute(), polyBoundaryMesh::matchGroups(), HashTable< const regIOobject * >::merge(), probes::prepare(), ensightSurfaceReader::readCase(), cuttingSurfaceBase::walkCellCuts(), and regionSizeDistribution::write().

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 508 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 548 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 569 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)

Referenced by ensightWrite::write(), and vtkWrite::write().

Here is the caller graph for this function:

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

◆ clear()

void clear ( )

Remove all entries from table.

Definition at line 749 of file HashTable.C.

Referenced by polyMeshTetDecomposition::adjustTetBasePtIs(), Foam::calcCellCellsImpl(), cellToCellStencil::calcFaceCells(), cellToFaceStencil::calcFaceCells(), zoneCellStencils::calcFaceCells(), cellToFaceStencil::calcFaceStencil(), primitiveMesh::checkFaceFaces(), interfaceDefinitions::clear(), objectRegistry::clear(), faMeshDecomposition::decomposeMesh(), Pstream::exchangeSizes(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findBox(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findBox(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findSphere(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findSphere(), triSurfaceLoader::load(), cellTable::operator=(), NASedgeFormat::read(), STARCDsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), STARCDedgeFormat::read(), wallBoundedStreamLine::read(), hashedWordList::rehash(), vtuSizing::reset(), tetDecomposer::setRefinement(), addPatchCellLayer::setRefinement(), cuttingSurfaceBase::walkCellCuts(), and areaWrite::write().

Here is the caller graph for this function:

◆ clearStorage()

void clearStorage ( )

Remove all entries from table and the table itself.

Equivalent to clear() followed by setCapacity(0)

Definition at line 774 of file HashTable.C.

Referenced by objectRegistry::clearStorage().

Here is the caller graph for this function:

◆ setCapacity()

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

◆ resize()

void resize ( label newCapacity )

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

Definition at line 729 of file HashTable.C.

Referenced by removePoints::setRefinement(), topoBitSet::topoBitSet(), and topoBoolSet::topoBoolSet().

Here is the caller graph for this function:

◆ reserve()

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

Referenced by cellTable::addCellZones(), wallDistAddressing::correct(), faMeshDecomposition::decomposeMesh(), Pstream::exchangeSizes(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findBox(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findBox(), dynamicIndexedOctree< Foam::dynamicTreeDataPoint >::findSphere(), indexedOctree< Foam::treeDataPrimitivePatch< PatchType > >::findSphere(), Foam::getAcceptableFunctionKeys(), faBoundaryMesh::indices(), ZoneMesh< cellZone, polyMesh >::indices(), polyBoundaryMesh::indices(), isoSurfaceTopo::isoSurfaceTopo(), processorTopology::New(), polyBoundaryMesh::patchSet(), hashedWordList::rehash(), and removePoints::setRefinement().

Here is the caller graph for this function:

◆ swap()

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

noexcept

Swap contents into this table.

Definition at line 787 of file HashTable.C.

◆ transfer()

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

Transfer contents into this table.

Definition at line 801 of file HashTable.C.

Referenced by primitiveMesh::checkEdgeLength(), polyBoundaryMesh::matchGroups(), NASedgeFormat::read(), STARCDedgeFormat::read(), cellZoneSet::subtractSet(), pointZoneSet::subtractSet(), and extendedEdgeMesh::transfer().

Here is the caller graph for this function:

◆ merge() [1/2]

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

◆ merge() [2/2]

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

◆ operator[]() [1/2]

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.

◆ operator[]() [2/2]

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.

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

◆ operator=() [1/3]

void operator= ( const this_type & rhs )

Copy assign.

◆ 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 959 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 985 of file HashTable.C.

◆ operator!=()

bool operator!= ( const this_type & rhs ) const

The opposite of the equality operation.

Definition at line 1011 of file HashTable.C.

◆ operator+=()

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

Add entries into this HashTable.

Definition at line 1021 of file HashTable.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 1295 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 167 of file HashTableIterI.H.

Referenced by Foam::kShellIntegration(), and HashTable< const regIOobject * >::merge().

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 175 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 183 of file HashTableIterI.H.

Referenced by HashTable< const regIOobject * >::erase(), multiphaseInterSystem::generatePhi(), HashSet< word, Hash< word > >::HashSet(), exprResultGlobals::Table::Table(), and regionSizeDistribution::write().

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 191 of file HashTableIterI.H.

Referenced by HashTable< const regIOobject * >::merge(), duplicatePoints::setRefinement(), and 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 199 of file HashTableIterI.H.

◆ cend()

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

inlinenoexcept

const_iterator to signal the end (for any HashTable)

Definition at line 207 of file HashTableIterI.H.

Referenced by HashTable< const regIOobject * >::erase(), multiphaseInterSystem::generatePhi(), HashSet< word, Hash< word > >::HashSet(), and exprResultGlobals::Table::Table().

Here is the caller graph for this function:

◆ printInfo()

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

Print information.

Definition at line 40 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 77 of file HashTableIO.C.

◆ found()

bool found ( const Key & key ) const

inline

Same as contains()

Definition at line 1370 of file HashTable.H.

Referenced by topOVariablesBase::addBoundaryFacesToIsoline(), snappyLayerDriver::addLayers(), snappyLayerDriver::addLayersSinglePass(), exprResultGlobals::addValue(), BlendedInterfacialModel< Foam::turbulentDispersionModel >::BlendedInterfacialModel(), layerAdditionRemoval::changeTopology(), edgeMeshFormatsCore::checkSupport(), surfaceFormatsCore::checkSupport(), patchPatchDist::correct(), motionSmootherAlgo::correctBoundaryConditions(), cellDistFuncs::correctBoundaryPointCells(), parseDriver::field_cellSelection(), parseDriver::field_faceSelection(), surfaceSets::getHangingCells(), removePoints::getUnrefimentSet(), cellCellStencil::interpolate(), cellFeatures::isFeatureEdge(), UnsortedMeshedSurface< Face >::New(), MeshedSurface< Foam::face >::New(), orderedPhasePair::orderedPhasePair(), InflationInjection< CloudType >::parcelsToInject(), STARCDMeshReader::readBoundary(), STARCDMeshReader::readCells(), motionSmootherAlgo::setDisplacementPatchFields(), faGlobalMeshData::updateMesh(), faMesh::updateMesh(), cuttingSurfaceBase::walkCellCuts(), UnsortedMeshedSurface< Face >::write(), MeshedSurface< Foam::face >::write(), and regionSizeDistribution::write().

Here is the caller graph for this function:

◆ sorted() [2/2]

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]

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

Definition at line 175 of file HashTable.C.

◆ tocKeys() [2/2]

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

Definition at line 228 of file HashTable.C.

◆ tocValues() [2/2]

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

Definition at line 254 of file HashTable.C.

◆ tocEntries() [2/2]

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

Definition at line 280 of file HashTable.C.

◆ countKeys() [2/2]

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

Definition at line 306 of file HashTable.C.

◆ countValues() [2/2]

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

Definition at line 328 of file HashTable.C.

◆ countEntries() [2/2]

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

Definition at line 350 of file HashTable.C.

◆ erase() [8/10]

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

inline

Definition at line 522 of file HashTable.C.

◆ erase() [9/10]

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

inline

Definition at line 559 of file HashTable.C.

◆ erase() [10/10]

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

Definition at line 580 of file HashTable.C.

◆ retain() [2/2]

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

Definition at line 628 of file HashTable.C.

◆ filterKeys() [2/2]

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

Definition at line 816 of file HashTable.C.

◆ filterValues() [2/2]

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

Definition at line 843 of file HashTable.C.

◆ filterEntries() [2/2]

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

Definition at line 870 of file HashTable.C.

Friends And Related Function Documentation

◆ Iterator< true >

friend class Iterator< true >

friend

Allow iterator access to HashTable internals.

Definition at line 849 of file HashTable.H.

Referenced by HashTable< const regIOobject * >::begin(), and HashTable< const regIOobject * >::cbegin().

◆ Iterator< false >

friend class Iterator< false >

friend

Allow iterator access to HashTable internals.

Definition at line 859 of file HashTable.H.

Referenced by HashTable< const regIOobject * >::begin().

◆ operator>>

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

friend

◆ operator

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

friend

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

Friends

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ this_type

◆ node_type

◆ key_type

◆ mapped_type

◆ value_type

◆ hasher

◆ pointer

◆ reference

◆ const_pointer

◆ const_reference

◆ difference_type

◆ size_type

◆ key_iterator

◆ const_key_iterator

Constructor & Destructor Documentation

◆ HashTable() [1/8]

◆ HashTable() [2/8]

◆ HashTable() [3/8]

◆ HashTable() [4/8]

◆ HashTable() [5/8]

◆ HashTable() [6/8]

◆ HashTable() [7/8]

◆ HashTable() [8/8]

◆ ~HashTable()

Member Function Documentation

◆ empty()

◆ size()

◆ capacity()

◆ at() [1/2]

◆ at() [2/2]

◆ contains()

◆ find() [1/2]

◆ find() [2/2]

◆ cfind()

◆ lookup()

◆ toc()

◆ sortedToc() [1/3]

◆ sortedToc() [2/3]

◆ tocKeys() [1/2]

◆ tocValues() [1/2]

◆ tocEntries() [1/2]

◆ csorted()

◆ sorted() [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]

◆ clear()

◆ clearStorage()

◆ setCapacity()

◆ resize()

◆ reserve()

◆ swap()

◆ transfer()

◆ merge() [1/2]

◆ merge() [2/2]

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