HashSet< Key, Hash > Class Template Reference

A HashTable with keys but without contents that is similar to std::unordered_set. More...

#include <HashSet.H>

Inheritance diagram for HashSet< Key, Hash >:

Collaboration diagram for HashSet< Key, Hash >:

Public Types
typedef HashSet< Key, Hash >	this_type
	The template instance used for this HashSet.
typedef HashTable< Foam::zero, Key, Hash >	parent_type
	The template instance used for the parent HashTable.
using	iterator = typename parent_type::key_iterator
	An iterator, returning reference to the key.
using	const_iterator = typename parent_type::const_key_iterator
	A const_iterator, returning reference to the key.
Public Types inherited from HashTable< T, Key, Hash >
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	HashSet () noexcept=default
	Default construct: empty without allocation (capacity=0).
constexpr	HashSet (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashSet (const label initialCapacity)
	Construct empty with initial table capacity.
	HashSet (const this_type &rhs)
	Copy construct.
	HashSet (this_type &&rhs) noexcept
	Move construct.
	HashSet (Istream &is)
	Construct from Istream with default initial table capacity.
template<unsigned N>
	HashSet (const FixedList< Key, N > &list)
	Construct from FixedList of Key.
	HashSet (const UList< Key > &list)
	Construct from UList of Key.
template<class Addr>
	HashSet (const IndirectListBase< Key, Addr > &list)
	Construct from an indirect list.
	HashSet (std::initializer_list< Key > list)
	Construct from an initializer list of Key.
template<class AnyType, class AnyHash>
	HashSet (const HashTable< AnyType, Key, AnyHash > &tbl)
	Construct from the keys of another HashTable, the type of values held is arbitrary.
bool	test (const Key &key) const
	Same as contains() - return true if key exists in the set.
bool	insert (const Key &key)
	Insert a new entry, not overwriting existing entries.
bool	set (const Key &key)
	Same as insert (no value to overwrite).
bool	unset (const Key &key)
	Unset the specified key - same as erase.
void	merge (HashSet< 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 (HashSet< 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.
template<class InputIter>
label	insert (InputIter first, InputIter last)
	Insert keys from the input iterator range.
label	insert (std::initializer_list< Key > list)
	Insert keys from a initializer list of Key.
template<unsigned N>
label	insert (const FixedList< Key, N > &list)
	Insert keys from the list of Key.
label	insert (const UList< Key > &list)
	Insert keys from the list of Key.
template<class Addr>
label	insert (const IndirectListBase< Key, Addr > &list)
	Insert keys from the list of Key.
template<class InputIter>
label	set (InputIter first, InputIter last)
	Same as insert (no value to overwrite).
label	set (std::initializer_list< Key > list)
	Same as insert (no value to overwrite).
template<unsigned N>
label	set (const FixedList< Key, N > &list)
	Same as insert (no value to overwrite).
label	set (const UList< Key > &list)
	Same as insert (no value to overwrite).
template<class Addr>
label	set (const IndirectListBase< Key, Addr > &list)
	Same as insert (no value to overwrite).
template<class InputIter>
label	setMany (InputIter first, InputIter last)
	Same as insert (no value to overwrite).
template<class InputIter>
label	unset (InputIter first, InputIter last)
	Unset the keys listed in the input iterator range.
label	unset (std::initializer_list< Key > list)
	Unset the listed keys - same as erase.
template<unsigned N>
label	unset (const FixedList< Key, N > &list)
	Unset the listed keys - same as erase.
label	unset (const UList< Key > &list)
	Unset the listed keys - same as erase.
template<class Addr>
label	unset (const IndirectListBase< Key, Addr > &list)
	Unset the listed keys - same as erase.
iterator	begin ()
const_iterator	begin () const
const_iterator	cbegin () const
iterator	end () noexcept
const_iterator	end () const noexcept
constexpr const_iterator	cend () const noexcept
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen.
bool	operator() (const Key &key) const noexcept
	Return true if the entry exists, same as contains().
bool	operator[] (const Key &key) const noexcept
	Return true if the entry exists, same as contains().
void	operator= (const this_type &rhs)
	Copy assign.
void	operator= (this_type &&rhs)
	Move assign.
bool	operator== (const this_type &rhs) const
	Sets are equal if all keys are equal, independent of order or underlying storage size.
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation.
void	operator= (const UList< Key > &rhs)
	Assignment from a UList of keys.
template<unsigned N>
void	operator= (const FixedList< Key, N > &rhs)
	Assignment from a FixedList of keys.
void	operator= (std::initializer_list< Key > rhs)
	Assignment from an initializer list of keys.
this_type &	operator|= (const this_type &rhs)
	Add entries to this HashSet.
this_type &	operator&= (const this_type &rhs)
	Only retain entries contained in both HashSets.
this_type &	operator^= (const this_type &rhs)
	Only retain unique entries (xor).
this_type &	operator+= (const this_type &rhs)
	Add entries to this HashSet. Same as the '|=' operator.
this_type &	operator-= (const this_type &rhs)
	Remove entries from this HashSet. Uses erase().
template<class UnaryPredicate>
List< Key >	tocValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
template<class BinaryPredicate>
List< Key >	tocEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
template<class UnaryPredicate>
label	countValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
template<class BinaryPredicate>
label	countEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
template<class UnaryPredicate>
label	filterValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
template<class BinaryPredicate>
label	filterEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
template<class InputIter>
Foam::label	assignMany (const label nItems, InputIter first, InputIter last)
template<class InputIter>
Foam::label	insert (InputIter first, InputIter last)
template<unsigned N>
Foam::label	insert (const FixedList< Key, N > &list)
template<class Addr>
Foam::label	insert (const IndirectListBase< Key, Addr > &list)
template<class InputIter>
Foam::label	unset (InputIter first, InputIter last)
template<unsigned N>
Foam::label	unset (const FixedList< Key, N > &list)
template<class Addr>
Foam::label	unset (const IndirectListBase< Key, Addr > &list)
Public Member Functions inherited from HashTable< T, Key, Hash >
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.

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 Key, class Hash = Foam::Hash<Key>>
class Foam::HashSet< Key, Hash >

A HashTable with keys but without contents that is similar to std::unordered_set.

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.

Note

The HashSet iterator dereferences to the key, so the following range-for works as expected:

labelHashSet someLabels{10, 20, 30, 40, ...};
for (const label i : someLabels)
{
    Info<< "val:" << i << nl;
}

Definition at line 93 of file HashSet.H.

Member Typedef Documentation

this_type

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

typedef HashSet<Key, Hash> this_type

The template instance used for this HashSet.

Definition at line 116 of file HashSet.H.

parent_type

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

typedef HashTable<Foam::zero, Key, Hash> parent_type

The template instance used for the parent HashTable.

Definition at line 121 of file HashSet.H.

iterator

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

using iterator = typename parent_type::key_iterator

An iterator, returning reference to the key.

Definition at line 126 of file HashSet.H.

const_iterator

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

using const_iterator = typename parent_type::const_key_iterator

A const_iterator, returning reference to the key.

Definition at line 131 of file HashSet.H.

Constructor & Destructor Documentation

HashSet() [1/11]

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

HashSet ( )

constexprdefaultnoexcept

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

Referenced by merge(), merge(), operator!=(), operator&=(), operator+=(), operator-=(), operator==(), operator^=(), and operator|=().

Here is the caller graph for this function:

HashSet() [2/11]

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

HashSet ( Foam::zero )

inlineexplicitconstexprnoexcept

Construct empty without allocation (capacity=0).

Definition at line 144 of file HashSet.H.

HashSet() [3/11]

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

HashSet ( const label initialCapacity )

inlineexplicit

Construct empty with initial table capacity.

Definition at line 149 of file HashSet.H.

HashSet() [4/11]

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

HashSet ( const this_type & rhs )

inline

Copy construct.

Definition at line 157 of file HashSet.H.

HashSet() [5/11]

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

HashSet ( this_type && rhs )

inlinenoexcept

Move construct.

Definition at line 165 of file HashSet.H.

HashSet() [6/11]

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

HashSet ( Istream & is )

inlineexplicit

Construct from Istream with default initial table capacity.

Definition at line 173 of file HashSet.H.

HashSet() [7/11]

template<class Key, class Hash>

template<unsigned N>

HashSet ( const FixedList< Key, N > & list )

explicit

Construct from FixedList of Key.

Definition at line 50 of file HashSet.C.

References FixedList< T, N >::begin(), FixedList< T, N >::end(), insert(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

HashSet() [8/11]

template<class Key, class Hash>

HashSet ( const UList< Key > & list )

explicit

Construct from UList of Key.

Definition at line 59 of file HashSet.C.

References UList< T >::begin(), UList< T >::end(), insert(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

HashSet() [9/11]

template<class Key, class Hash>

template<class Addr>

HashSet ( const IndirectListBase< Key, Addr > & list )

explicit

Construct from an indirect list.

Definition at line 69 of file HashSet.C.

References IndirectListBase< T, Addr >::begin(), IndirectListBase< T, Addr >::end(), insert(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

HashSet() [10/11]

template<class Key, class Hash>

HashSet

(

std::initializer_list< Key >

list

)

Construct from an initializer list of Key.

Definition at line 78 of file HashSet.C.

References insert(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

HashSet() [11/11]

template<class Key, class Hash>

template<class AnyType, class AnyHash>

HashSet ( const HashTable< AnyType, Key, AnyHash > & tbl )

explicit

Construct from the keys of another HashTable, the type of values held is arbitrary.

Definition at line 88 of file HashSet.C.

References HashTable< T, Key, Hash >::cbegin(), HashTable< T, Key, Hash >::cend(), HashTable< T, Key, Hash >::HashTable(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

Member Function Documentation

test()

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

bool test ( const Key & key ) const

inline

Same as contains() - return true if key exists in the set.

Method name compatibility with bitSet and boolList.

Definition at line 215 of file HashSet.H.

Referenced by mappedPatchBase::calcMapping().

Here is the caller graph for this function:

insert() [1/9]

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

bool insert ( const Key & key )

inline

Insert a new entry, not overwriting existing entries.

Returns

True if the entry inserted, which means that it did not previously exist in the set.

Definition at line 229 of file HashSet.H.

Referenced by PDRblock::blockMeshDict(), faMesh::boundaryProcs(), faPatch::boundaryProcs(), boundaryRadiationProperties::boundaryRadiationProperties(), Foam::calcCellCellsImpl(), cellToFaceStencil::calcFaceStencil(), faPatch::calcPointLabels(), geometricElementTransformPointSmoother::calculate(), solarLoad::calculate(), extractEulerianParticles::calculateAddressing(), polyMeshGeometry::checkCellDeterminant(), primitiveMeshGeometry::checkCellDeterminant(), primitiveMesh::checkCellsZipUp(), primitiveMesh::checkCellVolumes(), primitiveMesh::checkClosedCells(), primitiveMesh::checkCommonOrder(), primitiveMesh::checkConcaveCells(), zone::checkDefinition(), primitiveMesh::checkDuplicateFaces(), polyMeshGeometry::checkEdgeLength(), primitiveMesh::checkEdgeLength(), polyMeshGeometry::checkFaceAngles(), primitiveMesh::checkFaceAngles(), primitiveMeshGeometry::checkFaceAngles(), polyMeshGeometry::checkFaceArea(), primitiveMeshGeometry::checkFaceArea(), primitiveMesh::checkFaceAreas(), primitiveMeshGeometry::checkFaceDotProduct(), polyMeshGeometry::checkFaceFlatness(), primitiveMesh::checkFaceFlatness(), primitiveMesh::checkFaceOrthogonality(), polyMeshGeometry::checkFacePyramids(), primitiveMesh::checkFacePyramids(), primitiveMeshGeometry::checkFacePyramids(), polyMeshGeometry::checkFaceSkewness(), primitiveMesh::checkFaceSkewness(), primitiveMeshGeometry::checkFaceSkewness(), polyMeshGeometry::checkFaceTets(), polyMeshTetDecomposition::checkFaceTets(), polyMeshGeometry::checkFaceTwist(), primitiveMeshGeometry::checkFaceTwist(), primitiveMesh::checkFaceVertices(), polyMeshGeometry::checkFaceWeights(), primitiveMeshGeometry::checkFaceWeights(), motionSmootherAlgo::checkMesh(), motionSmootherAlgo::checkMesh(), PatchTools::checkOrientation(), primitiveMesh::checkPointNearness(), primitiveMesh::checkPoints(), polyMeshGeometry::checkTriangleTwist(), primitiveMesh::checkUpperTriangular(), polyMeshGeometry::checkVolRatio(), hexRef8::consistentSlowRefinement2(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), meshRefinement::createBaffles(), box::createMap(), curvatureSeparation::curvatureSeparation(), geomCellLooper::cut(), hexCellLooper::cut(), Foam::meshTools::cutDirToEdge(), structuredDecomp::decompose(), meshRefinement::doRemovePoints(), meshRefinement::doRestorePoints(), Foam::getAcceptableFunctionKeys(), surfaceSets::getHangingCells(), combineFaces::getMergeSets(), cellDistFuncs::getPointNeighbours(), surfaceSets::getSurfaceSets(), removePoints::getUnrefimentSet(), triSurfaceTools::getVertexVertices(), 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(), cellToCellStencil::insertFaceCells(), cellToFaceStencil::insertFaceCells(), zoneCellStencils::insertFaceCells(), oversetFvMeshBase::interpolateFields(), Foam::interpolatePointToCell(), isoSurfaceTopo::isoSurfaceTopo(), displacementPointSmoothingMotionSolver::markAffectedFaces(), displacementSmartPointSmoothingMotionSolver::markAffectedFaces(), edgeMesh::mergeEdges(), surfaceIntersection::mergeEdges(), meshRefinement::mergePatchFaces(), meshRefinement::mergePatchFacesUndo(), noiseFFT::octaveBandInfo(), HashSet< Foam::string >::operator[](), faceAreaWeightAMI2D::overlappingTgtFaces(), InflationInjection< CloudType >::parcelsToInject(), ParticleErosion< CloudType >::ParticleErosion(), polyBoundaryMesh::patchSet(), Foam::polyMeshZipUpCells(), Probes< ProbeType >::prepare(), Foam::printBadEntries(), NASsurfaceFormat< Face >::read(), AMIWeights::read(), fieldExtents::read(), ensightSurfaceReader::readCase(), functionObjectList::readFunctionObject(), triSurface::readTypes(), structuredRenumber::renumber(), faMeshBoundaryHalo::reset(), motionSmootherAlgo::scaleMesh(), mapDistributeBase::schedule(), triSurfaceLoader::select(), cellSetOption::setCellSelection(), noiseModel::setOctaveBands(), addPatchCellLayer::setRefinement(), hexRef8::setRefinement(), perfectInterface::setRefinement(), removeFaces::setRefinement(), removePoints::setRefinement(), hexRef8::setUnrefinement(), meshRefinement::splitFacesUndo(), marchingCells::update(), edgeVertex::updateLabels(), Foam::HashSetOps::used(), Foam::HashSetOps::used(), cuttingSurfaceBase::walkCellCuts(), Foam::meshTools::writeOBJ(), triSurface::writeStats(), isoAdvection::writeSurfaceCells(), and triSurface::writeTypes().

set() [1/6]

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

bool set ( const Key & key )

inline

Same as insert (no value to overwrite).

Definition at line 237 of file HashSet.H.

Referenced by mappedPatchBase::calcMapping(), Foam::checkFireEdges(), cellSet::distribute(), faceSet::distribute(), pointSet::distribute(), Foam::BitOps::set(), faceSet::sync(), pointSet::sync(), and topoSet::updateLabels().

Here is the caller graph for this function:

unset() [1/9]

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

bool unset ( const Key & key )

inline

Unset the specified key - same as erase.

Returns

True if the entry existed and was removed

Definition at line 247 of file HashSet.H.

Referenced by Foam::listSwitches(), Foam::BitOps::unset(), unset(), and unset().

Here is the caller graph for this function:

merge() [1/2]

template<class Key, class Hash>

void merge

(

HashSet< 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 222 of file HashSet.C.

References HashSet(), and HashTable< Foam::zero, Key, Hash >::merge().

Here is the call graph for this function:

merge() [2/2]

template<class Key, class Hash>

void merge

(

HashSet< 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 229 of file HashSet.C.

References HashSet(), and HashTable< Foam::zero, Key, Hash >::merge().

Here is the call graph for this function:

insert() [2/9]

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

template<class InputIter>

label insert ( InputIter first, InputIter last )

inline

Insert keys from the input iterator range.

Returns

The number of new elements inserted

insert() [3/9]

template<class Key, class Hash>

Foam::label insert ( std::initializer_list< Key > list )

inline

Insert keys from a initializer list of Key.

Returns

The number of new elements inserted

Definition at line 126 of file HashSet.C.

References insert().

Here is the call graph for this function:

insert() [4/9]

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

template<unsigned N>

label insert ( const FixedList< Key, N > & list )

inline

Insert keys from the list of Key.

Returns

The number of new elements inserted

insert() [5/9]

template<class Key, class Hash>

Foam::label insert ( const UList< Key > & list )

inline

Insert keys from the list of Key.

Returns

The number of new elements inserted

Definition at line 147 of file HashSet.C.

References UList< T >::begin(), UList< T >::end(), and insert().

Here is the call graph for this function:

insert() [6/9]

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

template<class Addr>

label insert ( const IndirectListBase< Key, Addr > & list )

inline

Insert keys from the list of Key.

Returns

The number of new elements inserted

set() [2/6]

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

template<class InputIter>

label set ( InputIter first, InputIter last )

inline

Same as insert (no value to overwrite).

Definition at line 311 of file HashSet.H.

set() [3/6]

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

label set ( std::initializer_list< Key > list )

inline

Same as insert (no value to overwrite).

Definition at line 319 of file HashSet.H.

set() [4/6]

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

template<unsigned N>

label set ( const FixedList< Key, N > & list )

inline

Same as insert (no value to overwrite).

Definition at line 328 of file HashSet.H.

set() [5/6]

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

label set ( const UList< Key > & list )

inline

Same as insert (no value to overwrite).

Definition at line 336 of file HashSet.H.

set() [6/6]

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

template<class Addr>

label set ( const IndirectListBase< Key, Addr > & list )

inline

Same as insert (no value to overwrite).

Definition at line 345 of file HashSet.H.

setMany()

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

template<class InputIter>

label setMany ( InputIter first, InputIter last )

inline

Same as insert (no value to overwrite).

Note

Method name compatibility with bitSet

Definition at line 356 of file HashSet.H.

unset() [2/9]

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

template<class InputIter>

label unset ( InputIter first, InputIter last )

inline

Unset the keys listed in the input iterator range.

Returns

The number of items removed

unset() [3/9]

template<class Key, class Hash>

Foam::label unset ( std::initializer_list< Key > list )

inline

Unset the listed keys - same as erase.

Returns

The number of items removed

Definition at line 180 of file HashSet.C.

References unset().

Here is the call graph for this function:

unset() [4/9]

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

template<unsigned N>

label unset ( const FixedList< Key, N > & list )

inline

Unset the listed keys - same as erase.

Returns

The number of items removed

unset() [5/9]

template<class Key, class Hash>

Foam::label unset ( const UList< Key > & list )

inline

Unset the listed keys - same as erase.

Returns

The number of items removed

Definition at line 201 of file HashSet.C.

References UList< T >::begin(), UList< T >::end(), and unset().

Here is the call graph for this function:

unset() [6/9]

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

template<class Addr>

label unset ( const IndirectListBase< Key, Addr > & list )

inline

Unset the listed keys - same as erase.

Returns

The number of items removed

begin() [1/2]

template<class Key, class Hash>

Foam::HashSet< Key, Hash >::iterator begin ( )

inline

Definition at line 453 of file HashSet.C.

Referenced by cellToFaceZone::applyToSet(), holeToFace::applyToSet(), Foam::HashSetOps::bitset(), and Foam::HashSetOps::bools().

Here is the caller graph for this function:

begin() [2/2]

template<class Key, class Hash>

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

inline

Definition at line 464 of file HashSet.C.

cbegin()

template<class Key, class Hash>

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

inline

Definition at line 475 of file HashSet.C.

end() [1/2]

template<class Key, class Hash>

Foam::HashSet< Key, Hash >::iterator end ( )

inlinenoexcept

Definition at line 486 of file HashSet.C.

References Foam::noexcept.

Referenced by cellToFaceZone::applyToSet(), holeToFace::applyToSet(), Foam::HashSetOps::bitset(), and Foam::HashSetOps::bools().

Here is the caller graph for this function:

end() [2/2]

template<class Key, class Hash>

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

inlinenoexcept

Definition at line 494 of file HashSet.C.

References Foam::noexcept.

cend()

template<class Key, class Hash>

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

inlineconstexprnoexcept

Definition at line 502 of file HashSet.C.

References Foam::noexcept.

writeList()

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

Ostream & writeList ( Ostream & os, const label shortLen = 0 ) const

inline

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

Using '0' suppresses line-breaks entirely.

Definition at line 419 of file HashSet.H.

operator()()

template<class Key, class Hash>

bool operator() ( const Key & key ) const

inlinenoexcept

Return true if the entry exists, same as contains().

Note

this allows use of HashSet as a predicate test

Definition at line 238 of file HashSet.C.

References HashTable< T, Key, Hash >::contains().

Here is the call graph for this function:

operator[]()

template<class Key, class Hash>

bool operator[] ( const Key & key ) const

inlinenoexcept

Return true if the entry exists, same as contains().

Definition at line 245 of file HashSet.C.

References HashTable< T, Key, Hash >::contains().

Here is the call graph for this function:

operator=() [1/5]

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

void operator= ( const this_type & rhs )

inline

Copy assign.

Definition at line 442 of file HashSet.H.

operator=() [2/5]

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

void operator= ( this_type && rhs )

inline

Move assign.

Definition at line 450 of file HashSet.H.

operator==()

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

bool operator==

(

const this_type &

rhs

)

const

Sets are equal if all keys are equal, independent of order or underlying storage size.

Definition at line 274 of file HashSet.C.

References HashTable< T, Key, Hash >::contains(), HashSet(), Foam::rhs(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

operator!=()

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

bool operator!=

(

const this_type &

rhs

)

const

The opposite of the equality operation.

Definition at line 299 of file HashSet.C.

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

Here is the call graph for this function:

operator=() [3/5]

template<class Key, class Hash>

void operator=

(

const UList< Key > &

rhs

)

Assignment from a UList of keys.

Definition at line 260 of file HashSet.C.

References Foam::rhs().

Here is the call graph for this function:

operator=() [4/5]

template<class Key, class Hash>

template<unsigned N>

void operator=

(

const FixedList< Key, N > &

rhs

)

Assignment from a FixedList of keys.

Definition at line 253 of file HashSet.C.

References Foam::rhs().

Here is the call graph for this function:

operator=() [5/5]

template<class Key, class Hash>

void operator=

(

std::initializer_list< Key >

rhs

)

Assignment from an initializer list of keys.

Definition at line 267 of file HashSet.C.

References Foam::rhs().

Here is the call graph for this function:

operator|=()

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

Foam::HashSet< Key, Hash > & operator|=

(

const this_type &

rhs

)

Add entries to this HashSet.

Definition at line 307 of file HashSet.C.

References HashSet(), insert(), and Foam::rhs().

Referenced by operator+=().

Here is the call graph for this function:

Here is the caller graph for this function:

operator&=()

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

Foam::HashSet< Key, Hash > & operator&= ( const this_type & rhs )

inline

Only retain entries contained in both HashSets.

Definition at line 324 of file HashSet.C.

References HashSet(), HashTable< Foam::zero, Key, Hash >::retain(), and Foam::rhs().

Here is the call graph for this function:

operator^=()

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

Foam::HashSet< Key, Hash > & operator^=

(

const this_type &

rhs

)

Only retain unique entries (xor).

Definition at line 333 of file HashSet.C.

References HashTable< T, Key, Hash >::contains(), erase(), HashSet(), insert(), and Foam::rhs().

Here is the call graph for this function:

operator+=()

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

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

inline

Add entries to this HashSet. Same as the '|=' operator.

Definition at line 354 of file HashSet.C.

References HashSet(), operator|=(), and Foam::rhs().

Here is the call graph for this function:

operator-=()

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

Foam::HashSet< Key, Hash > & operator-= ( const this_type & rhs )

inline

Remove entries from this HashSet. Uses erase().

Definition at line 362 of file HashSet.C.

References HashTable< Foam::zero, Key, Hash >::erase(), HashSet(), and Foam::rhs().

Here is the call graph for this function:

tocValues()

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

template<class UnaryPredicate>

List< Key > tocValues ( const UnaryPredicate & , const bool  )

delete

Not applicable for HashSet.

tocEntries()

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

template<class BinaryPredicate>

List< Key > tocEntries ( const BinaryPredicate & , const bool  )

delete

Not applicable for HashSet.

countValues()

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

template<class UnaryPredicate>

label countValues ( const UnaryPredicate & , const bool  )

delete

Not applicable for HashSet.

countEntries()

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

template<class BinaryPredicate>

label countEntries ( const BinaryPredicate & , const bool  )

delete

Not applicable for HashSet.

filterValues()

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

template<class UnaryPredicate>

label filterValues ( const UnaryPredicate & , const bool  )

delete

Not applicable for HashSet.

filterEntries()

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

template<class BinaryPredicate>

label filterEntries ( const BinaryPredicate & , const bool  )

delete

Not applicable for HashSet.

assignMany()

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

template<class InputIter>

Foam::label assignMany ( const label nItems, InputIter first, InputIter last )

inline

Definition at line 32 of file HashSet.C.

insert() [7/9]

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

template<class InputIter>

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

inline

Definition at line 106 of file HashSet.C.

insert() [8/9]

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

template<unsigned N>

Foam::label insert ( const FixedList< Key, N > & list )

inline

Definition at line 137 of file HashSet.C.

insert() [9/9]

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

template<class Addr>

Foam::label insert ( const IndirectListBase< Key, Addr > & list )

inline

Definition at line 158 of file HashSet.C.

unset() [7/9]

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

template<class InputIter>

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

inline

Definition at line 169 of file HashSet.C.

unset() [8/9]

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

template<unsigned N>

Foam::label unset ( const FixedList< Key, N > & list )

inline

Definition at line 191 of file HashSet.C.

unset() [9/9]

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

template<class Addr>

Foam::label unset ( const IndirectListBase< Key, Addr > & list )

inline

Definition at line 212 of file HashSet.C.

---

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

• src/OpenFOAM/containers/HashTables/HashSet/HashSet.H
• src/OpenFOAM/containers/HashTables/HashSet/HashSet.C