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 >:

Collaboration diagram for HashSet< Key, Hash >:

Public Types
typedef HashSet< Key, Hash >	this_type
	The template instance used for this HashSet. More...
typedef HashTable< zero::null, Key, Hash >	parent_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 Types inherited from HashTable< zero::null, Key, Hash >
typedef HashTable< zero::null, Key, Hash >	this_type
	The template instance used for this HashTable. More...
typedef Key	key_type
	The second template parameter, type of keys used. More...
typedef zero::null	mapped_type
	The first template parameter, type of objects contained. More...
typedef zero::null	value_type
	Same as mapped_type for OpenFOAM HashTables. More...
typedef Hash	hasher
	The third template parameter, the hash index method. More...
typedef zero::null *	pointer
	Pointer type for storing into value_type objects. More...
typedef zero::null &	reference
	Reference to the stored value_type. More...
typedef label	difference_type
	The type to represent the difference between two iterators. More...
typedef label	size_type
	The type that can represent the size of a HashTable. More...
using	key_iterator = key_iterator_base< iterator >
	Forward iterator returning the key. More...
using	const_key_iterator = key_iterator_base< const_iterator >
	Forward const iterator returning the key. More...

Public Member Functions
	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
Ostream &	writeList (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 assignment. More...
void	operator= (this_type &&rhs)
	Move assignment. 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_type &	operator|= (const this_type &rhs)
	Add entries to this HashSet. More...
this_type &	operator&= (const this_type &rhs)
	Only retain entries found in both HashSets. More...
this_type &	operator^= (const this_type &rhs)
	Only retain unique entries (xor) More...
this_type &	operator+= (const this_type &rhs)
	Add entries to this HashSet. Same as the '|=' operator. More...
this_type &	operator-= (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)
Public Member Functions inherited from HashTable< zero::null, Key, Hash >
	HashTable ()
	Default construct with default (128) table capacity. More...
	HashTable (const label size)
	Construct given initial table capacity. More...
	HashTable (Istream &is, const label size=128)
	Construct from Istream with default table capacity. More...
	HashTable (const this_type &ht)
	Copy construct. More...
	HashTable (this_type &&rhs)
	Move construct. More...
	HashTable (std::initializer_list< std::pair< Key, zero::null >> list)
	Construct from an initializer list. More...
	~HashTable ()
	Destructor. More...
label	capacity () const noexcept
	The size of the underlying table. More...
label	size () const noexcept
	The number of elements in table. More...
bool	empty () const noexcept
	True if the hash table is empty. More...
zero::null &	at (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...
const zero::null &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...
bool	found (const Key &key) const
	Return true if hashed entry is found in table. More...
iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry. More...
const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...
const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry. More...
const zero::null &	lookup (const Key &key, const zero::null &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...
List< Key >	sortedToc (const Compare &comp) const
Foam::List< Key >	sortedToc (const Compare &comp) const
List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const
Foam::List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert) const
List< Key >	tocValues (const UnaryPredicate &pred, const bool invert=false) const
Foam::List< Key >	tocValues (const UnaryPredicate &pred, const bool invert) const
List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const
Foam::List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert) const
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate. More...
Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate. More...
Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate. More...
Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...
bool	insert (const Key &key, const zero::null &obj)
	Copy insert a new entry, not overwriting existing entries. More...
bool	insert (const Key &key, zero::null &&obj)
	Move insert a new entry, not overwriting existing entries. More...
bool	set (const Key &key, const zero::null &obj)
	Copy assign a new entry, overwriting existing entries. More...
bool	set (const Key &key, zero::null &&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...
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...
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys. More...
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...
Foam::label	erase (InputIter first, InputIter last)
Foam::label	erase (const FixedList< Key, N > &keys)
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &other)
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table. More...
Foam::label	retain (const HashTable< AnyType, Key, AnyHash > &other)
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys. More...
Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values. More...
Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value. More...
Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)
void	resize (const label sz)
	Resize the hash table for efficiency. More...
void	clear ()
	Clear all entries from table. More...
void	clearStorage ()
	Clear the table entries and the table itself. More...
void	swap (HashTable< zero::null, Key, Hash > &rhs)
	Swap contents into this table. More...
void	transfer (HashTable< zero::null, Key, Hash > &rhs)
	Transfer contents into this table. More...
zero::null &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist. More...
const zero::null &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...
zero::null &	operator() (const Key &key)
	Return existing entry or create a new entry. More...
zero::null &	operator() (const Key &key, const zero::null &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, zero::null >> rhs)
	Copy assign from an initializer list. More...
void	operator= (this_type &&rhs)
	Move assign. More...
bool	operator== (const this_type &rhs) const
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation. More...
this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable. More...
const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys. More...
iterator	begin ()
	iterator set to the beginning of the HashTable More...
const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...
const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...
iterator	end () noexcept
	iterator to signal the end (for any HashTable) More...
const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable) More...
constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable) More...
Ostream &	printInfo (Ostream &os) const
	Print information. More...
Ostream &	writeKeys (Ostream &os, const label shortLen=0) const

Additional Inherited Members
Public Attributes inherited from HashTable< zero::null, Key, Hash >
const typedef zero::null *	const_pointer
	Const pointer type for the stored value_type. More...
const typedef zero::null &	const_reference
	Const reference to the stored value_type. More...
Protected Member Functions inherited from HashTable< zero::null, Key, Hash >
bool	iterator_erase (node_type *&entry, label &index)
	Low-level entry erasure using iterator internals. More...

Detailed Description

template<class Key = word, class Hash = string::hash>
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 83 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 102 of file HashSet.H.

parent_type

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

The template instance used for the parent HashTable.

Definition at line 105 of file HashSet.H.

iterator

using iterator = typename parent_type::key_iterator

An iterator, returning reference to the key.

Definition at line 108 of file HashSet.H.

const_iterator

using const_iterator = typename parent_type::const_key_iterator

A const_iterator, returning reference to the key.

Definition at line 111 of file HashSet.H.

Constructor & Destructor Documentation

HashSet() [1/10]

HashSet ( )

inline

Default construct with default (128) table capacity.

Definition at line 117 of file HashSet.H.

HashSet() [2/10]

HashSet ( const this_type &  rhs )

inline

Copy construct.

Definition at line 123 of file HashSet.H.

HashSet() [3/10]

HashSet ( this_type &&  rhs )

inline

Move construct.

Definition at line 129 of file HashSet.H.

HashSet() [4/10]

HashSet ( const label  size )

inlineexplicit

Construct given initial table capacity.

Definition at line 135 of file HashSet.H.

HashSet() [5/10]

HashSet ( Istream &  is )

inlineexplicit

Construct from Istream with default table capacity.

Definition at line 141 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 76 of file HashSet.C.

HashSet() [8/10]

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

explicit

Construct from an indirect list.

Definition at line 89 of file HashSet.C.

HashSet() [9/10]

HashSet

(

std::initializer_list< Key >

list

)

Construct from an initializer list of Key.

Definition at line 101 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 115 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 170 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 181 of file HashSet.H.

Referenced by polyMeshGeometry::affectedCells(), decompositionMethod::calcCellCells(), cellToFaceStencil::calcFaceStencil(), solarLoad::calculate(), extractEulerianParticles::calculateAddressing(), primitiveMesh::cellEdges(), primitiveMesh::cellPoints(), 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(), fvMeshDistribute::distribute(), meshRefinement::doRemovePoints(), faMesh::faMesh(), combineFaces::getMergeSets(), surfaceSets::getSurfaceSets(), triSurfaceTools::getVertexVertices(), polyBoundaryMesh::indices(), zoneCellStencils::insertFaceCells(), cellToCellStencil::insertFaceCells(), cellToFaceStencil::insertFaceCells(), seriesWriter::load(), cellToCellStencil::merge(), cellToFaceStencil::merge(), zoneCellStencils::merge(), unionEqOp::operator()(), InflationInjection< CloudType >::parcelsToInject(), ParticleErosion< CloudType >::ParticleErosion(), polyBoundaryMesh::patchSet(), Foam::polyMeshZipUpCells(), probes::prepare(), Foam::printBadEntries(), NASsurfaceFormat< Face >::read(), AMIWeights::read(), wallHeatFlux::read(), wallShearStress::read(), triSurfaceLoader::readDir(), functionObjectList::readFunctionObject(), triSurface::readTypes(), structuredRenumber::renumber(), vtuSizing::reset(), motionSmootherAlgo::scaleMesh(), mapDistributeBase::schedule(), fieldSelection::selectionNames(), HashSet< Foam::string >::set(), cellSetOption::setCellSet(), lumpedPointMovement::setInterpolator(), HashSet< Foam::string >::setMany(), lumpedPointMovement::setPatchControl(), removePoints::setRefinement(), faGlobalMeshData::updateMesh(), Foam::HashSetOps::used(), 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 187 of file HashSet.H.

Referenced by mappedPatchBase::calcMapping(), Foam::checkFireEdges(), lumpedPointMovement::readDict(), plicRDF::reconstruct(), 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 194 of file HashSet.H.

Referenced by Foam::listSwitches(), 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 152 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 173 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 227 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 233 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 240 of file HashSet.H.

set() [5/6]

label set ( const UList< Key > &  list )

inline

Same as insert (no value to overwrite)

Definition at line 246 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 253 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 261 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 206 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 227 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 428 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 439 of file HashSet.C.

cbegin()

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

inline

Definition at line 450 of file HashSet.C.

Referenced by HashSet< Foam::string >::operator==(), HashSet< Foam::string >::operator^=(), and HashSet< Foam::string >::operator|=().

Here is the caller graph for this function:

end() [1/2]

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

inlinenoexcept

Definition at line 461 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 469 of file HashSet.C.

cend()

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

inlineconstexprnoexcept

Definition at line 477 of file HashSet.C.

Referenced by HashSet< Foam::string >::operator==(), HashSet< Foam::string >::operator^=(), and HashSet< Foam::string >::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 306 of file HashSet.H.

operator()()

bool operator() ( const Key &  key ) const

inlinenoexcept

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

Definition at line 249 of file HashSet.C.

operator[]()

bool operator[] ( const Key &  key ) const

inlinenoexcept

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

Definition at line 256 of file HashSet.C.

operator=() [1/5]

void operator= ( const this_type &  rhs )

inline

Copy assignment.

Definition at line 323 of file HashSet.H.

operator=() [2/5]

void operator= ( this_type &&  rhs )

inline

Move assignment.

Definition at line 329 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 285 of file HashSet.C.

operator!=()

bool operator!=

(

const this_type &

rhs

)

const

The opposite of the equality operation.

Definition at line 306 of file HashSet.C.

operator=() [3/5]

void operator=

(

const UList< Key > &

rhs

)

Assignment from a UList of keys.

Definition at line 271 of file HashSet.C.

operator=() [4/5]

void operator=

(

const FixedList< Key, N > &

rhs

)

Assignment from a FixedList of keys.

Definition at line 264 of file HashSet.C.

operator=() [5/5]

void operator=

(

std::initializer_list< Key >

rhs

)

Assignment from an initializer list of keys.

Definition at line 278 of file HashSet.C.

operator|=()

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

(

const this_type &

rhs

)

Add entries to this HashSet.

Definition at line 314 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 328 of file HashSet.C.

operator^=()

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

(

const this_type &

rhs

)

Only retain unique entries (xor)

Definition at line 337 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 358 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 366 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 133 of file HashSet.C.

insert() [8/9]

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

inline

Definition at line 163 of file HashSet.C.

insert() [9/9]

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

inline

Definition at line 184 of file HashSet.C.

unset() [7/9]

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

inline

Definition at line 195 of file HashSet.C.

unset() [8/9]

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

inline

Definition at line 217 of file HashSet.C.

unset() [9/9]

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

inline

Definition at line 238 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