An STL-conforming hash table. More...

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

[legend]

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

Classes
class	const_iterator
	An STL-conforming const_iterator. More...

class	iterator
	An STL-conforming iterator. More...

class	iteratorBase
	The iterator base for HashTable. More...

Public Types
typedef T	value_type
	Type of values the HashTable contains. More...

typedef T &	reference
	Type that can be used for storing into HashTable::value_type. More...

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

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

Public Member Functions
	HashTable (const label size=128)
	Construct given initial table size. More...

	HashTable (Istream &, const label size=128)
	Construct from Istream. More...

	HashTable (const UList< Key > &keyList, const UList< T > &elmtList)
	Construct from a list of keys and list of elements. More...

	HashTable (const HashTable< T, Key, Hash > &)
	Copy constructor. More...

	HashTable (HashTable< T, Key, Hash > &&)
	Move constructor. More...

	HashTable (std::initializer_list< Tuple2< Key, T >>)
	Construct from an initialiser list. More...

	~HashTable ()
	Destructor. More...

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

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

bool	empty () const
	Return true if the hash table is empty. More...

bool	found (const Key &) const
	Return true if hashedEntry is found in table. More...

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

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

List< Key >	toc () const
	Return the table of contents. More...

List< Key >	sortedToc () const
	Return the table of contents as a sorted list. More...

List< const_iterator >	sorted () const
	Return a sorted list of constant iterators. More...

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

bool	insert (const Key &, const T &newElmt)
	Insert a new hashedEntry. More...

void	insert (const HashTable< T, Key, Hash > &)
	Insert all the entries from the given HashTable. More...

bool	set (const Key &, const T &newElmt)
	Set a new hashedEntry, overwriting existing entries. More...

void	set (const HashTable< T, Key, Hash > &)
	Insert all the entries from the given HashTable,. More...

bool	erase (const iterator &)
	Erase a hashedEntry specified by given iterator. More...

bool	erase (const Key &)
	Erase a hashedEntry specified by the given key. More...

label	erase (const UList< Key > &)
	Remove entries given by the listed keys from this HashTable. More...

template<class AnyType , class AnyHash >
label	erase (const HashTable< AnyType, Key, AnyHash > &)
	Remove entries given by the given keys from this HashTable. More...

void	resize (const label newSize)
	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	shrink ()
	Shrink the allocated table to approx. twice number of elements. More...

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

T &	operator[] (const Key &)
	Find and return a hashedEntry. More...

const T &	operator[] (const Key &) const
	Find and return a hashedEntry. More...

T &	operator() (const Key &)
	Find and return a hashedEntry, create it null if not present. More...

void	operator= (const HashTable< T, Key, Hash > &)
	Assignment operator. More...

void	operator= (HashTable< T, Key, Hash > &&)
	Move assignment operator. More...

void	operator= (std::initializer_list< Tuple2< Key, T >>)
	Assignment to an initialiser list. More...

bool	operator== (const HashTable< T, Key, Hash > &) const
	Equality. Hash tables are equal if the keys and values are equal. More...

bool	operator!= (const HashTable< T, Key, Hash > &) const
	The opposite of the equality operation. Takes linear time. More...

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

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

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

template<class AnyType , class AnyHash >
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &rhs)

Public Member Functions inherited from HashTableCore
	HashTableCore ()
	Construct null. More...

	ClassName ("HashTable")
	Define template name and debug. More...

Friends
template<class T2 , class Key2 , class Hash2 >
class	HashPtrTable
	Declare friendship with the HashPtrTable class. More...

class	iteratorBase
	Declare friendship with the iteratorBase. More...

class	iterator
	Declare friendship with the iterator. More...

class	const_iterator
	Declare friendship with the const_iterator. More...

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

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

Additional Inherited Members
Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label)
	Return a canonical (power-of-two) size. More...

static iteratorEnd	cend ()
	iteratorEnd set to beyond the end of any HashTable More...

static iteratorEnd	end ()
	iteratorEnd set to beyond the end of any HashTable More...

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable table size. More...

Detailed Description

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

An STL-conforming hash table.

Note: Hashing index collisions are handled via chaining using a singly-linked list with the colliding entry being added to the head of the linked list. Thus copying the hash table (or indeed even resizing it) will often result in a different hash order. Use a sorted table-of-contents when the hash order is important.

Source files

Definition at line 124 of file HashTable.H.

Member Typedef Documentation

◆ value_type

typedef T value_type

Type of values the HashTable contains.

Definition at line 346 of file HashTable.H.

◆ reference

typedef T& reference

Type that can be used for storing into HashTable::value_type.

objects. This type is usually List::value_type&.

Definition at line 350 of file HashTable.H.

◆ const_reference

typedef const T& const_reference

Type that can be used for storing into constant.

HashTable::value_type objects. This type is usually const HashTable::value_type&.

Definition at line 355 of file HashTable.H.

◆ size_type

typedef label size_type

The type that can represent the size of a HashTable.

Definition at line 358 of file HashTable.H.

Constructor & Destructor Documentation

◆ HashTable() [1/6]

HashTable ( const label size = 128 )

Construct given initial table size.

Definition at line 36 of file HashTable.C.

◆ HashTable() [2/6]

HashTable	(	Istream &	is,
		const label	size = `128`
	)

Construct from Istream.

Definition at line 33 of file HashTableIO.C.

References HashTable< T, Key, Hash >::operator>>.

◆ HashTable() [3/6]

HashTable	(	const UList< Key > &	keyList,
		const UList< T > &	elmtList
	)

Construct from a list of keys and list of elements.

Lists must have equal length

Definition at line 83 of file HashTable.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, HashTable< T, Key, Hash >::insert(), Foam::nl, and UList< T >::size().

Here is the call graph for this function:

◆ HashTable() [4/6]

HashTable ( const HashTable< T, Key, Hash > & ht )

Copy constructor.

Definition at line 56 of file HashTable.C.

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

Here is the call graph for this function:

◆ HashTable() [5/6]

HashTable ( HashTable< T, Key, Hash > && ht )

Move constructor.

Definition at line 68 of file HashTable.C.

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

Here is the call graph for this function:

◆ HashTable() [6/6]

HashTable ( std::initializer_list< Tuple2< Key, T >> lst )

Construct from an initialiser list.

Definition at line 108 of file HashTable.C.

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

Here is the call graph for this function:

◆ ~HashTable()

~HashTable

Destructor.

Definition at line 125 of file HashTable.C.

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ capacity()

Foam::label capacity

inline

The size of the underlying table.

Definition at line 58 of file HashTableI.H.

◆ size()

Foam::label size

inline

Return number of elements in table.

Definition at line 65 of file HashTableI.H.

Referenced by singleProcessorFaceSetsConstraint::add(), snappyLayerDriver::addLayers(), normalToFace::applyToSet(), cellToFaceStencil::calcFaceStencil(), createShellMesh::calcPointRegions(), GAMGAgglomeration::calculateRegionMaster(), pointMVCWeight::calcWeights(), Foam::meshCheck::checkEdgeAlignment(), Foam::meshCheck::checkEdgeLength(), Foam::meshCheck::checkGeometry(), Foam::meshCheck::checkMesh(), edgeCollapser::checkMeshQuality(), Foam::meshCheck::checkTopology(), cellTable::combine(), hexRef8::consistentSlowRefinement(), hexRef8::consistentSlowRefinement2(), cyclicPolyPatch::coupledEdges(), meshRefinement::createZoneBaffles(), snappyLayerDriver::doLayers(), snappySnapDriver::doSnap(), meshRefinement::dupNonManifoldPoints(), surfaceSets::getHangingCells(), combineFaces::getMergeSets(), removePoints::getUnrefimentSet(), Foam::interpolatePointToCell(), layerParameters::layerParameters(), lduPrimitiveMesh::lduPrimitiveMesh(), polyBoundaryMesh::matchGroups(), cellToCellStencil::merge(), cellToFaceStencil::merge(), Foam::meshCheck::mergeAndWrite(), edgeMesh::mergeEdges(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), meshToMesh::meshToMesh(), polyBoundaryMesh::nbrEdges(), inversePointDistanceDiffusivity::operator()(), Foam::polyMeshZipUpCells(), rigidBodyPoints::read(), repatchMesh::readTriSurface(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), structuredRenumber::renumber(), faceZone::reset(), motionSmootherAlgo::scaleMesh(), fvMeshSubset::setCellSubset(), removePoints::setRefinement(), hexRef8::setRefinement(), edgeCollapser::setRefinement(), duplicatePoints::setRefinement(), hexRef8::setUnrefinement(), UnsortedMeshedSurface< Face >::sortedZones(), surfaceFeatures::surfaceFeatures(), faceZoneSet::sync(), pointSet::sync(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), triSurfaceRegionSearch::treeByRegion(), loadBalancer::update(), edgeVertex::updateLabels(), regionSizeDistribution::write(), domainDecomposition::writeComplete(), and domainDecomposition::writeProcs().

Here is the caller graph for this function:

◆ empty()

bool empty

inline

Return true if the hash table is empty.

Definition at line 72 of file HashTableI.H.

Referenced by forcesBase::calcForcesMoments(), phaseSystem::solve(), globalIndexAndTransform::transformIndicesForPatches(), and TriPatchIntersection< SrcPatchType, TgtPatchType >::TriPatchIntersection().

Here is the caller graph for this function:

◆ found()

bool found ( const Key & key ) const

Return true if hashedEntry is found in table.

Definition at line 138 of file HashTable.C.

References InfoInFunction.

Referenced by Foam::addField(), cellZoneSet::addSet(), pointZoneSet::addSet(), twoPhaseSolver::alphaPhi(), setToCellZone::applyToSet(), faceZoneToFaceZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), setToFaceZone::applyToSet(), setToPointZone::applyToSet(), addPatchCellLayer::calcSidePatch(), edgeMeshFormatsCore::checkSupport(), surfaceFormatsCore::checkSupport(), meshRefinement::collectFaces(), motionSmootherAlgo::correctBoundaryConditions(), nearWallFields::createFields(), dynamicMeshPointInterpolator::curPointField(), curvatureSeparation::curvatureSeparation(), geomCellLooper::cut(), hexCellLooper::cut(), Foam::meshTools::cutDirToEdge(), cellZoneSet::deleteSet(), pointZoneSet::deleteSet(), HashTable< T, Key, Hash >::erase(), BlendedInterfacialModel< ModelType >::evaluate(), polyMeshFilter::filter(), surfaceSets::getHangingCells(), removePoints::getUnrefimentSet(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::InterfaceCompositionPhaseChangePhaseSystem(), cellZoneSet::invert(), faceZoneSet::invert(), pointZoneSet::invert(), fvMeshAdder::MapDimFields(), fvMeshAdder::MapPointFields(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), meshRefinement::mergePatchFacesUndo(), MeshedSurface< Face >::New(), UnsortedMeshedSurface< Face >::New(), sampledSet::New(), HashSet< Key, Hash >::operator&=(), inversePointDistanceDiffusivity::operator()(), HashSet< Key, Hash >::operator==(), turbulenceFields::processField(), STARCD::readBoundary(), Foam::readFields(), fieldAverage::readMeanFieldType(), Foam::readUniformFields(), fvMeshSubset::setCellSubset(), motionSmootherAlgo::setDisplacementPatchFields(), refinementIterator::setRefinement(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::specieTransfer(), cellZoneSet::subset(), pointZoneSet::subset(), surfaceIntersection::surfaceIntersection(), faceSet::sync(), faceZone::topoChange(), TriPatchIntersection< SrcPatchType, TgtPatchType >::TriPatchIntersection(), wideBand::wideBand(), regionSizeDistribution::write(), MeshedSurface< Face >::write(), UnsortedMeshedSurface< Face >::write(), domainDecomposition::writeComplete(), and domainDecomposition::writeProcs().

Here is the caller graph for this function:

◆ find() [1/2]

Foam::HashTable< T, Key, Hash >::iterator find ( const Key & key )

Find and return an iterator set at the hashedEntry.

If not found iterator = end()

Definition at line 166 of file HashTable.C.

References InfoInFunction.

Referenced by cellTable::addCellZones(), faceZoneSet::addSet(), cellMatcher::calcLocalFaces(), createShellMesh::calcPointRegions(), GAMGAgglomeration::calculateRegionMaster(), Foam::meshCheck::checkFaceFaces(), objectRegistry::checkIn(), objectRegistry::checkOut(), patchPatchDist::correct(), cyclicPolyPatch::coupledEdges(), meshRefinement::createZoneBaffles(), cutPolyIsoSurface::cutPolyIsoSurface(), cyclicGAMGInterface::cyclicGAMGInterface(), faceZoneSet::deleteSet(), combineFaces::getMergeSets(), snappySnapDriver::getZoneSurfacePoints(), polyBoundaryMesh::groupPatchIndices(), Foam::stringOps::inplaceExpandCodeTemplate(), fvMeshSubset::interpolate(), lduPrimitiveMesh::lduPrimitiveMesh(), DictionaryBase< IDLListType, T >::lookup(), DictionaryBase< IDLListType, T >::lookupPtr(), PatchTools::matchEdges(), PatchTools::matchPoints(), globalMeshData::mergePoints(), polyBoundaryMesh::nbrEdges(), PatchTools::pointNormals(), processorGAMGInterface::processorGAMGInterface(), NASsurfaceFormat< Face >::read(), OBJsurfaceFormat< Face >::read(), STARCDsurfaceFormat< Face >::read(), STARCD::readBoundary(), Foam::readUniformFields(), regionSizeDistribution::regionSum(), DictionaryBase< IDLListType, T >::remove(), undoableMeshCutter::removeSplitFaces(), undoableMeshCutter::setRefinement(), edgeCollapser::setRefinement(), duplicatePoints::setRefinement(), combineFaces::setUnrefinement(), phaseSystem::solve(), UnsortedMeshedSurface< Face >::sortedZones(), faceZoneSet::subset(), surfaceFeatures::surfaceFeatures(), syncTools::syncEdgeList(), syncTools::syncEdgeMap(), syncTools::syncPointList(), syncTools::syncPointMap(), hexRef8::topoChange(), meshReader::warnDuplicates(), PrimitivePatch<::Foam::List< Face >, pointField >::whichPoint(), and meshRefinement::zonify().

Here is the caller graph for this function:

◆ find() [2/2]

Foam::HashTable< T, Key, Hash >::const_iterator find ( const Key & key ) const

Find and return an const_iterator set at the hashedEntry.

If not found iterator = end()

Definition at line 197 of file HashTable.C.

◆ toc()

Foam::List< Key > toc

Return the table of contents.

Definition at line 227 of file HashTable.C.

Referenced by cellToCellStencil::calcFaceCells(), cellToFaceStencil::calcFaceCells(), cellTable::combine(), meshRefinement::createBaffles(), dynamicIndexedOctree< Type >::findBox(), indexedOctree< Type >::findBox(), dynamicIndexedOctree< Type >::findSphere(), indexedOctree< Type >::findSphere(), Foam::meshCheck::getAffectedCells(), removePoints::getUnrefimentSet(), triSurfaceTools::getVertexVertices(), cellToCellStencil::unionEqOp::operator()(), cellToFaceStencil::unionEqOp::operator()(), ParticleErosion< CloudType >::ParticleErosion(), PatchPostProcessing< CloudType >::PatchPostProcessing(), Foam::polyMeshZipUpCells(), writeDictionary::read(), Foam::readDir(), distributionMapBase::schedule(), fvMeshSubset::setCellSubset(), hexRef8::setUnrefinement(), and Foam::meshTools::writeOBJ().

Here is the caller graph for this function:

◆ sortedToc()

Foam::List< Key > sortedToc

Return the table of contents as a sorted list.

Definition at line 242 of file HashTable.C.

Referenced by preservePatchesConstraint::add(), singleProcessorFaceSetsConstraint::add(), Foam::AddPatchFields(), preservePatchesConstraint::apply(), edgeMeshFormatsCore::checkSupport(), surfaceFormatsCore::checkSupport(), coupleGroupIdentifier::findOtherPatchID(), Zone< ZoneType, ZonesType >::insert(), Foam::listAllConfigFiles(), Foam::listSwitches(), Foam::meshCheck::mergeAndWrite(), Foam::meshCheck::printMeshStats(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), Foam::ReorderPatchFields(), cellZoneSet::sync(), pointZoneSet::sync(), and regionSizeDistribution::write().

Here is the caller graph for this function:

◆ sorted()

Foam::List< typename Foam::HashTable< T, Key, Hash >::const_iterator > sorted

Return a sorted list of constant iterators.

Definition at line 253 of file HashTable.C.

Referenced by faceZone::reset().

Here is the caller graph for this function:

◆ printInfo()

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

Print information.

Definition at line 58 of file HashTableIO.C.

References Foam::count(), and Foam::endl().

Here is the call graph for this function:

◆ insert() [1/2]

bool insert	(	const Key &	key,
		const T &	newElmt
	)

inline

Insert a new hashedEntry.

Definition at line 79 of file HashTableI.H.

Here is the caller graph for this function:

◆ insert() [2/2]

void insert ( const HashTable< T, Key, Hash > & ht )

Insert all the entries from the given HashTable.

Definition at line 363 of file HashTable.C.

References HashTable< T, Key, Hash >::cbegin(), HashTableCore::cend(), and Foam::vtkWriteOps::insert().

Here is the call graph for this function:

◆ set() [1/2]

bool set	(	const Key &	key,
		const T &	newElmt
	)

inline

Set a new hashedEntry, overwriting existing entries.

Definition at line 90 of file HashTableI.H.

Referenced by Foam::addField(), reactionDriven::dmidtf(), edgeCollapser::markSmallEdges(), domainDecomposition::procFaceAddressingBf(), STARCDedgeFormat::read(), and syncTools::syncPointMap().

Here is the caller graph for this function:

◆ set() [2/2]

void set ( const HashTable< T, Key, Hash > & ht )

Insert all the entries from the given HashTable,.

overwriting existing entries

Definition at line 373 of file HashTable.C.

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

Here is the call graph for this function:

◆ erase() [1/5]

bool erase ( const iterator & iter )

Erase a hashedEntry specified by given iterator.

This invalidates the iterator until the next operator++

Definition at line 445 of file HashTable.C.

References erase().

Referenced by topoSetSource::addOrDelete(), fileOperation::addWatches(), masterUncollatedFileOperation::addWatches(), normalToFace::applyToSet(), objectRegistry::checkOut(), cellTable::combine(), cyclicPolyPatch::coupledEdges(), polyBoundaryMesh::groupPatchIndices(), polyBoundaryMesh::matchGroups(), polyBoundaryMesh::nbrEdges(), probes::prepare(), Foam::readUniformFields(), refinementRegions::refinementRegions(), refinementSurfaces::refinementSurfaces(), HashPtrTable< T, Key, Hash >::remove(), perfectInterface::setRefinement(), HashSet< Key, Hash >::unset(), and regionSizeDistribution::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ erase() [2/5]

bool erase ( const Key & key )

Erase a hashedEntry specified by the given key.

Definition at line 457 of file HashTable.C.

References erase().

Here is the call graph for this function:

◆ erase() [3/5]

Foam::label erase ( const UList< Key > & keys )

Remove entries given by the listed keys from this HashTable.

Return the number of elements removed

Definition at line 464 of file HashTable.C.

References Foam::count(), erase(), and UList< T >::size().

Here is the call graph for this function:

◆ erase() [4/5]

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

Remove entries given by the given keys from this HashTable.

Return the number of elements removed. The parameter HashTable needs the same type of key, but the type of values held and the hashing function are arbitrary.

◆ resize()

void resize ( const label newSize )

Resize the hash table for efficiency.

Definition at line 506 of file HashTable.C.

References HashTableCore::canonicalSize(), InfoInFunction, and HashTable< T, Key, Hash >::insert().

Referenced by Foam::meshCheck::checkEdgeAlignment(), Foam::meshCheck::checkWedges(), fvMeshDistribute::distribute(), removePoints::setRefinement(), edgeCollapser::setRefinement(), syncTools::syncPointMap(), cellZoneSet::updateSet(), faceZoneSet::updateSet(), and pointZoneSet::updateSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void clear

Clear all entries from table.

Definition at line 542 of file HashTable.C.

Referenced by Residuals< Type >::append(), decompositionMethod::calcCellCells(), cellToCellStencil::calcFaceCells(), cellToFaceStencil::calcFaceCells(), cellToFaceStencil::calcFaceStencil(), Foam::meshCheck::checkFaceFaces(), multiValveEngine::movingObject::createStaticPatchSet(), tetIndices::faceTriIs(), cellTable::operator=(), NASedgeFormat::read(), STARCDedgeFormat::read(), NASsurfaceFormat< Face >::read(), STARCDsurfaceFormat< Face >::read(), and surfaceFeatures::surfaceFeatures().

Here is the caller graph for this function:

◆ clearStorage()

void clearStorage

Clear the table entries and the table itself.

Equivalent to clear() followed by resize(0)

Definition at line 566 of file HashTable.C.

References clear(), and resize().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shrink()

void shrink

Shrink the allocated table to approx. twice number of elements.

Definition at line 574 of file HashTable.C.

References HashTableCore::canonicalSize(), and resize().

Here is the call graph for this function:

◆ transfer()

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

Transfer the contents of the argument table into this table.

and annul the argument table.

Definition at line 587 of file HashTable.C.

References clear().

Referenced by Foam::meshCheck::checkEdgeLength(), HashTable< T, Key, Hash >::HashTable(), polyBoundaryMesh::matchGroups(), NASedgeFormat::read(), STARCDedgeFormat::read(), populationBalanceModel::groups::retrieve(), motionSmootherAlgo::scaleMesh(), and pointSet::sync().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator[]() [1/2]

T & operator[] ( const Key & key )

inline

Find and return a hashedEntry.

Definition at line 103 of file HashTableI.H.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ operator[]() [2/2]

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

inline

Find and return a hashedEntry.

Definition at line 120 of file HashTableI.H.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ operator()()

T & operator() ( const Key & key )

inline

Find and return a hashedEntry, create it null if not present.

Definition at line 137 of file HashTableI.H.

References Foam::vtkWriteOps::insert(), and Foam::T().

Here is the call graph for this function:

◆ operator=() [1/3]

void operator= ( const HashTable< T, Key, Hash > & rhs )

Assignment operator.

Definition at line 610 of file HashTable.C.

References Foam::abort(), clear(), Foam::FatalError, FatalErrorInFunction, Foam::vtkWriteOps::insert(), and resize().

Referenced by HashPtrTable< T, Key, Hash >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/3]

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

Move assignment operator.

Definition at line 641 of file HashTable.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( std::initializer_list< Tuple2< Key, T >> lst )

Assignment to an initialiser list.

Definition at line 659 of file HashTable.C.

References clear(), Foam::vtkWriteOps::insert(), and resize().

Here is the call graph for this function:

◆ operator==()

bool operator== ( const HashTable< T, Key, Hash > & rhs ) const

Equality. Hash tables are equal if the keys and values are equal.

Independent of table storage size and table order.

Definition at line 682 of file HashTable.C.

◆ operator!=()

bool operator!= ( const HashTable< T, Key, Hash > & rhs ) const

The opposite of the equality operation. Takes linear time.

Definition at line 708 of file HashTable.C.

References Foam::operator==().

Here is the call graph for this function:

◆ begin() [1/2]

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

inline

Iterator set to the beginning of the HashTable.

Definition at line 411 of file HashTableI.H.

References HashTable< T, Key, Hash >::iterator.

Referenced by HashPtrTable< T, Key, Hash >::HashPtrTable(), basicThermo::lookupThermo(), polyBoundaryMesh::matchGroups(), multivariateScheme< Type, Scheme >::multivariateScheme(), multivariateSelectionScheme< Type >::multivariateSelectionScheme(), and regionSizeDistribution::write().

Here is the caller graph for this function:

◆ cbegin()

Foam::HashTable< T, Key, Hash >::const_iterator cbegin

inline

const_iterator set to the beginning of the HashTable

Definition at line 506 of file HashTableI.H.

References HashTable< T, Key, Hash >::const_iterator.

Referenced by HashTable< T, Key, Hash >::begin(), HashTable< T, Key, Hash >::HashTable(), HashTable< T, Key, Hash >::insert(), HashSet< Key, Hash >::operator-=(), HashSet< Key, Hash >::operator^=(), HashSet< Key, Hash >::operator|=(), and HashTable< T, Key, Hash >::set().

Here is the caller graph for this function:

◆ begin() [2/2]

Foam::HashTable< T, Key, Hash >::const_iterator begin

inline

const_iterator set to the beginning of the HashTable

Definition at line 514 of file HashTableI.H.

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

Here is the call graph for this function:

◆ erase() [5/5]

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

Definition at line 484 of file HashTable.C.

References Foam::count(), erase(), and HashTable< T, Key, Hash >::found().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ HashPtrTable

friend class HashPtrTable

friend

Declare friendship with the HashPtrTable class.

Definition at line 188 of file HashTable.H.

◆ iteratorBase

friend class iteratorBase

friend

Declare friendship with the iteratorBase.

Definition at line 191 of file HashTable.H.

◆ iterator

friend class iterator

friend

Declare friendship with the iterator.

Definition at line 194 of file HashTable.H.

Referenced by HashTable< T, Key, Hash >::begin().

◆ const_iterator

friend class const_iterator

friend

Declare friendship with the const_iterator.

Definition at line 197 of file HashTable.H.

Referenced by HashTable< T, Key, Hash >::cbegin().

◆ operator>>

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

friend

Referenced by HashTable< T, Key, Hash >::HashTable().

◆ operator

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

friend

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

src/OpenFOAM/containers/HashTables/HashTable/HashTable.H
src/OpenFOAM/containers/HashTables/HashTable/HashTable.C
src/OpenFOAM/containers/HashTables/HashTable/HashTableI.H
src/OpenFOAM/containers/HashTables/HashTable/HashTableIO.C

Classes

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ value_type

◆ reference

◆ const_reference

◆ size_type

Constructor & Destructor Documentation

◆ HashTable() [1/6]

◆ HashTable() [2/6]

◆ HashTable() [3/6]

◆ HashTable() [4/6]

◆ HashTable() [5/6]

◆ HashTable() [6/6]

◆ ~HashTable()

Member Function Documentation

◆ capacity()

◆ size()

◆ empty()

◆ found()

◆ find() [1/2]

◆ find() [2/2]

◆ toc()

◆ sortedToc()

◆ sorted()

◆ printInfo()

◆ insert() [1/2]

◆ insert() [2/2]

◆ set() [1/2]

◆ set() [2/2]

◆ erase() [1/5]

◆ erase() [2/5]

◆ erase() [3/5]

◆ erase() [4/5]

◆ resize()

◆ clear()

◆ clearStorage()

◆ shrink()

◆ transfer()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator()()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator==()

◆ operator!=()

◆ begin() [1/2]

◆ cbegin()

◆ begin() [2/2]

◆ erase() [5/5]

Friends And Related Function Documentation

◆ HashPtrTable

◆ iteratorBase

◆ iterator

◆ const_iterator

◆ operator>>

◆ operator

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