HashSet< Key, Hash > Class Template Reference

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

Inheritance diagram for HashSet< Key, Hash >:
[legend]

Public Types

typedef HashSet< Key, Hashthis_type
 The template instance used for this HashSet. More...
 
typedef HashTable< zero::null, Key, Hashparent_type
 The template instance used for the parent HashTable. More...
 
using iterator = typename parent_type::key_iterator
 An iterator, returning reference to the key. More...
 
using const_iterator = typename parent_type::const_key_iterator
 A const_iterator, returning reference to the key. More...
 

Public Member Functions

 HashSet ()
 Default construct with default (128) table capacity. More...
 
 HashSet (const this_type &rhs)
 Copy construct. More...
 
 HashSet (this_type &&rhs)
 Move construct. More...
 
 HashSet (const label size)
 Construct given initial table capacity. More...
 
 HashSet (Istream &is)
 Construct from Istream with default table capacity. More...
 
template<unsigned N>
 HashSet (const FixedList< Key, N > &list)
 Construct from FixedList of Key. More...
 
 HashSet (const UList< Key > &list)
 Construct from UList of Key. More...
 
template<class Addr >
 HashSet (const IndirectListBase< Key, Addr > &list)
 Construct from an indirect list. More...
 
 HashSet (std::initializer_list< Key > list)
 Construct from an initializer list of Key. More...
 
template<class AnyType , class AnyHash >
 HashSet (const HashTable< AnyType, Key, AnyHash > &tbl)
 
bool test (const Key &key) const noexcept
 Same as found() - return true if key exists in the set. More...
 
bool insert (const Key &key)
 Insert a new entry, not overwriting existing entries. More...
 
bool set (const Key &key)
 Same as insert (no value to overwrite) More...
 
bool unset (const Key &key)
 Unset the specified key - same as erase. More...
 
template<class InputIter >
label insert (InputIter first, InputIter last)
 Insert keys from the input iterator range. More...
 
label insert (std::initializer_list< Key > list)
 Insert keys from a initializer list of Key. More...
 
template<unsigned N>
label insert (const FixedList< Key, N > &list)
 Insert keys from the list of Key. More...
 
label insert (const UList< Key > &list)
 Insert keys from the list of Key. More...
 
template<class Addr >
label insert (const IndirectListBase< Key, Addr > &list)
 Insert keys from the list of Key. More...
 
template<class InputIter >
label set (InputIter first, InputIter last)
 Same as insert (no value to overwrite) More...
 
label set (std::initializer_list< Key > list)
 Same as insert (no value to overwrite) More...
 
template<unsigned N>
label set (const FixedList< Key, N > &list)
 Same as insert (no value to overwrite) More...
 
label set (const UList< Key > &list)
 Same as insert (no value to overwrite) More...
 
template<class Addr >
label set (const IndirectListBase< Key, Addr > &list)
 Same as insert (no value to overwrite) More...
 
template<class InputIter >
label setMany (InputIter first, InputIter last)
 Same as insert (no value to overwrite) More...
 
template<class InputIter >
label unset (InputIter first, InputIter last)
 Unset the keys listed in the input iterator range. More...
 
label unset (std::initializer_list< Key > list)
 Unset the listed keys - same as erase. More...
 
template<unsigned N>
label unset (const FixedList< Key, N > &list)
 Unset the listed keys - same as erase. More...
 
label unset (const UList< Key > &list)
 Unset the listed keys - same as erase. More...
 
template<class Addr >
label unset (const IndirectListBase< Key, Addr > &list)
 Unset the listed keys - same as erase. More...
 
iterator begin ()
 
const_iterator begin () const
 
const_iterator cbegin () const
 
iterator end () noexcept
 
const_iterator end () const noexcept
 
constexpr const_iterator cend () const noexcept
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 
bool operator() (const Key &key) const noexcept
 Return true if the entry exists, same as found() More...
 
bool operator[] (const Key &key) const noexcept
 Return true if the entry exists, same as found(). More...
 
void operator= (const this_type &rhs)
 Copy assign. More...
 
void operator= (this_type &&rhs)
 Move assign. More...
 
bool operator== (const this_type &rhs) const
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
void operator= (const UList< Key > &rhs)
 Assignment from a UList of keys. More...
 
template<unsigned N>
void operator= (const FixedList< Key, N > &rhs)
 Assignment from a FixedList of keys. More...
 
void operator= (std::initializer_list< Key > rhs)
 Assignment from an initializer list of keys. More...
 
this_typeoperator|= (const this_type &rhs)
 Add entries to this HashSet. More...
 
this_typeoperator&= (const this_type &rhs)
 Only retain entries found in both HashSets. More...
 
this_typeoperator^= (const this_type &rhs)
 Only retain unique entries (xor) More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries to this HashSet. Same as the '|=' operator. More...
 
this_typeoperator-= (const this_type &rhs)
 Remove entries from this HashSet. Uses erase() More...
 
template<class UnaryPredicate >
List< Key > tocValues (const UnaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
template<class BinaryPredicate >
List< Key > tocEntries (const BinaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
template<class UnaryPredicate >
label countValues (const UnaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
template<class BinaryPredicate >
label countEntries (const BinaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
template<class UnaryPredicate >
label filterValues (const UnaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
template<class BinaryPredicate >
label filterEntries (const BinaryPredicate &, const bool)=delete
 Not applicable for HashSet. More...
 
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)
 

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 77 of file HashSet.H.

Member Typedef Documentation

◆ this_type

typedef HashSet<Key, Hash> this_type

The template instance used for this HashSet.

Definition at line 112 of file HashSet.H.

◆ parent_type

The template instance used for the parent HashTable.

Definition at line 115 of file HashSet.H.

◆ iterator

An iterator, returning reference to the key.

Definition at line 118 of file HashSet.H.

◆ const_iterator

A const_iterator, returning reference to the key.

Definition at line 121 of file HashSet.H.

Constructor & Destructor Documentation

◆ HashSet() [1/10]

HashSet ( )
inline

Default construct with default (128) table capacity.

Definition at line 127 of file HashSet.H.

◆ HashSet() [2/10]

HashSet ( const this_type rhs)
inline

Copy construct.

Definition at line 133 of file HashSet.H.

◆ HashSet() [3/10]

HashSet ( this_type &&  rhs)
inline

Move construct.

Definition at line 139 of file HashSet.H.

◆ HashSet() [4/10]

HashSet ( const label  size)
inlineexplicit

Construct given initial table capacity.

Definition at line 145 of file HashSet.H.

◆ HashSet() [5/10]

HashSet ( Istream is)
inlineexplicit

Construct from Istream with default table capacity.

Definition at line 151 of file HashSet.H.

◆ HashSet() [6/10]

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

Construct from FixedList of Key.

Definition at line 64 of file HashSet.C.

◆ HashSet() [7/10]

HashSet ( const UList< Key > &  list)
explicit

Construct from UList of Key.

Definition at line 73 of file HashSet.C.

◆ HashSet() [8/10]

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

Construct from an indirect list.

Definition at line 83 of file HashSet.C.

◆ HashSet() [9/10]

HashSet ( std::initializer_list< Key >  list)

Construct from an initializer list of Key.

Definition at line 92 of file HashSet.C.

◆ HashSet() [10/10]

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

Member Function Documentation

◆ test()

bool test ( const Key &  key) const
inlinenoexcept

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

Method name compatibility with bitSet and boolList.

Definition at line 180 of file HashSet.H.

Referenced by mappedPatchBase::calcMapping().

Here is the caller graph for this function:

◆ insert() [1/9]

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

Referenced by polyMeshGeometry::affectedCells(), PDRblock::blockMeshDict(), faPatch::boundaryProcs(), faMesh::boundaryProcs(), decompositionMethod::calcCellCells(), cellToFaceStencil::calcFaceStencil(), solarLoad::calculate(), extractEulerianParticles::calculateAddressing(), primitiveMeshGeometry::checkCellDeterminant(), polyMeshGeometry::checkCellDeterminant(), primitiveMesh::checkCellsZipUp(), primitiveMesh::checkCellVolumes(), primitiveMesh::checkClosedCells(), primitiveMesh::checkCommonOrder(), primitiveMesh::checkConcaveCells(), zone::checkDefinition(), primitiveMesh::checkDuplicateFaces(), primitiveMesh::checkEdgeLength(), primitiveMeshGeometry::checkFaceAngles(), polyMeshGeometry::checkFaceAngles(), primitiveMesh::checkFaceAngles(), primitiveMeshGeometry::checkFaceArea(), polyMeshGeometry::checkFaceArea(), primitiveMesh::checkFaceAreas(), primitiveMeshGeometry::checkFaceDotProduct(), polyMeshGeometry::checkFaceFlatness(), primitiveMesh::checkFaceFlatness(), primitiveMesh::checkFaceOrthogonality(), primitiveMeshGeometry::checkFacePyramids(), polyMeshGeometry::checkFacePyramids(), primitiveMesh::checkFacePyramids(), primitiveMeshGeometry::checkFaceSkewness(), polyMeshGeometry::checkFaceSkewness(), primitiveMesh::checkFaceSkewness(), polyMeshTetDecomposition::checkFaceTets(), polyMeshGeometry::checkFaceTets(), primitiveMeshGeometry::checkFaceTwist(), polyMeshGeometry::checkFaceTwist(), primitiveMesh::checkFaceVertices(), primitiveMeshGeometry::checkFaceWeights(), polyMeshGeometry::checkFaceWeights(), PatchTools::checkOrientation(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::checkPointManifold(), primitiveMesh::checkPointNearness(), primitiveMesh::checkPoints(), PrimitivePatch<::Foam::List< labelledTri >, pointField >::checkTopology(), polyMeshGeometry::checkTriangleTwist(), primitiveMesh::checkUpperTriangular(), polyMeshGeometry::checkVolRatio(), meshRefinement::createBaffles(), box::createMap(), geomCellLooper::cut(), structuredDecomp::decompose(), faMeshDecomposition::decomposeMesh(), meshRefinement::doRemovePoints(), Foam::getAcceptableFunctionKeys(), combineFaces::getMergeSets(), surfaceSets::getSurfaceSets(), triSurfaceTools::getVertexVertices(), ZoneMesh< cellZone, polyMesh >::indices(), polyBoundaryMesh::indices(), cellToCellStencil::insertFaceCells(), cellToFaceStencil::insertFaceCells(), isoSurfaceTopo::isoSurfaceTopo(), seriesWriter::load(), faceAreaWeightAMI2D::overlappingTgtFaces(), InflationInjection< CloudType >::parcelsToInject(), ParticleErosion< CloudType >::ParticleErosion(), polyBoundaryMesh::patchSet(), Foam::polyMeshZipUpCells(), probes::prepare(), Foam::printBadEntries(), NASsurfaceFormat< Face >::read(), AMIWeights::read(), wallHeatFlux::read(), wallShearStress::read(), functionObjectList::readFunctionObject(), triSurface::readTypes(), structuredRenumber::renumber(), faMeshBoundaryHalo::reset(), vtuSizing::reset(), motionSmootherAlgo::scaleMesh(), mapDistributeBase::schedule(), HashSet< word, Hash< word > >::set(), cellSetOption::setCellSelection(), lumpedPointMovement::setInterpolator(), HashSet< word, Hash< word > >::setMany(), lumpedPointMovement::setPatchControl(), removePoints::setRefinement(), faGlobalMeshData::updateMesh(), cuttingSurfaceBase::walkCellCuts(), Foam::meshTools::writeOBJ(), triSurface::writeStats(), isoAdvection::writeSurfaceCells(), and triSurface::writeTypes().

◆ set() [1/6]

bool set ( const Key &  key)
inline

Same as insert (no value to overwrite)

Definition at line 197 of file HashSet.H.

Referenced by mappedPatchBase::calcMapping(), Foam::checkFireEdges(), lumpedPointMovement::readDict(), Foam::BitOps::set(), and topoSet::set().

Here is the caller graph for this function:

◆ unset() [1/9]

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 204 of file HashSet.H.

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

Here is the caller graph for this function:

◆ insert() [2/9]

label insert ( InputIter  first,
InputIter  last 
)
inline

Insert keys from the input iterator range.

Returns
The number of new elements inserted

◆ insert() [3/9]

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

◆ insert() [4/9]

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]

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

◆ insert() [6/9]

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]

label set ( InputIter  first,
InputIter  last 
)
inline

Same as insert (no value to overwrite)

Definition at line 237 of file HashSet.H.

◆ set() [3/6]

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

Same as insert (no value to overwrite)

Definition at line 243 of file HashSet.H.

◆ set() [4/6]

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

Same as insert (no value to overwrite)

Definition at line 250 of file HashSet.H.

◆ set() [5/6]

label set ( const UList< Key > &  list)
inline

Same as insert (no value to overwrite)

Definition at line 256 of file HashSet.H.

◆ set() [6/6]

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

Same as insert (no value to overwrite)

Definition at line 263 of file HashSet.H.

◆ setMany()

label setMany ( InputIter  first,
InputIter  last 
)
inline

Same as insert (no value to overwrite)

Note
Method name compatibility with bitSet

Definition at line 271 of file HashSet.H.

◆ unset() [2/9]

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]

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

◆ unset() [4/9]

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

Unset the listed keys - same as erase.

Returns
The number of items removed

◆ unset() [5/9]

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

Unset the listed keys - same as erase.

Returns
The number of items removed

Definition at line 216 of file HashSet.C.

◆ unset() [6/9]

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

Unset the listed keys - same as erase.

Returns
The number of items removed

◆ begin() [1/2]

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

Definition at line 446 of file HashSet.C.

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

Here is the caller graph for this function:

◆ begin() [2/2]

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

Definition at line 457 of file HashSet.C.

◆ cbegin()

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

Definition at line 468 of file HashSet.C.

Referenced by HashSet< word, Hash< word > >::operator==(), HashSet< word, Hash< word > >::operator^=(), and HashSet< word, Hash< word > >::operator|=().

Here is the caller graph for this function:

◆ end() [1/2]

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

Definition at line 479 of file HashSet.C.

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

Here is the caller graph for this function:

◆ end() [2/2]

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

Definition at line 487 of file HashSet.C.

◆ cend()

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

Definition at line 495 of file HashSet.C.

Referenced by HashSet< word, Hash< word > >::operator==(), HashSet< word, Hash< word > >::operator^=(), and HashSet< word, Hash< word > >::operator|=().

Here is the caller graph for this function:

◆ writeList()

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 316 of file HashSet.H.

◆ operator()()

bool operator() ( const Key &  key) const
inlinenoexcept

Return true if the entry exists, same as found()

Note
this allows use of HashSet as a predicate test

Definition at line 238 of file HashSet.C.

◆ operator[]()

bool operator[] ( const Key &  key) const
inlinenoexcept

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

Definition at line 245 of file HashSet.C.

◆ operator=() [1/5]

void operator= ( const this_type rhs)
inline

Copy assign.

Definition at line 332 of file HashSet.H.

◆ operator=() [2/5]

void operator= ( this_type &&  rhs)
inline

Move assign.

Definition at line 338 of file HashSet.H.

◆ operator==()

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.

◆ operator!=()

bool operator!= ( const this_type rhs) const

The opposite of the equality operation.

Definition at line 295 of file HashSet.C.

◆ operator=() [3/5]

void operator= ( const UList< Key > &  rhs)

Assignment from a UList of keys.

Definition at line 260 of file HashSet.C.

◆ operator=() [4/5]

void operator= ( const FixedList< Key, N > &  rhs)

Assignment from a FixedList of keys.

Definition at line 253 of file HashSet.C.

◆ operator=() [5/5]

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

Assignment from an initializer list of keys.

Definition at line 267 of file HashSet.C.

◆ operator|=()

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

Add entries to this HashSet.

Definition at line 303 of file HashSet.C.

◆ operator&=()

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

Only retain entries found in both HashSets.

Definition at line 317 of file HashSet.C.

◆ operator^=()

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

Only retain unique entries (xor)

Definition at line 326 of file HashSet.C.

◆ operator+=()

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

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

Definition at line 347 of file HashSet.C.

◆ operator-=()

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

Remove entries from this HashSet. Uses erase()

Definition at line 355 of file HashSet.C.

◆ tocValues()

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

Not applicable for HashSet.

◆ tocEntries()

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

Not applicable for HashSet.

◆ countValues()

label countValues ( const UnaryPredicate &  ,
const bool   
)
delete

Not applicable for HashSet.

◆ countEntries()

label countEntries ( const BinaryPredicate &  ,
const bool   
)
delete

Not applicable for HashSet.

◆ filterValues()

label filterValues ( const UnaryPredicate &  ,
const bool   
)
delete

Not applicable for HashSet.

◆ filterEntries()

label filterEntries ( const BinaryPredicate &  ,
const bool   
)
delete

Not applicable for HashSet.

◆ assignMany()

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

Definition at line 40 of file HashSet.C.

◆ insert() [7/9]

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

Definition at line 121 of file HashSet.C.

◆ insert() [8/9]

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

Definition at line 152 of file HashSet.C.

◆ insert() [9/9]

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

Definition at line 173 of file HashSet.C.

◆ unset() [7/9]

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

Definition at line 184 of file HashSet.C.

◆ unset() [8/9]

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

Definition at line 206 of file HashSet.C.

◆ unset() [9/9]

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

Definition at line 227 of file HashSet.C.


The documentation for this class was generated from the following files:
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::nl
constexpr char nl
Definition: Ostream.H:404
Foam::labelHashSet
HashSet< label, Hash< label > > labelHashSet
A HashSet of labels, uses label hasher.
Definition: HashSet.H:85