An STL-conforming hash table. More...

#include <OpenFOAM/HashTable.H>

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 84 of file HashTable.H.

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

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

List of all members.

Classes
class	const_iterator
	An STL-conforming const_iterator. More...
struct	hashedEntry
class	iterator
	An STL-conforming iterator. More...
Public Types
typedef T	value_type
	Type of values the HashTable contains.
typedef T &	reference
	Type that can be used for storing into HashTable::value_type.
typedef const T &	const_reference
	Type that can be used for storing into constant.
typedef label	size_type
	The type that can represent the size of a HashTable.
Public Member Functions
	HashTable (const label size=128)
	Construct given initial table size.
	HashTable (Istream &, const label size=128)
	Construct from Istream.
	HashTable (const HashTable< T, Key, Hash > &)
	Construct as copy.
	HashTable (const Xfer< HashTable< T, Key, Hash > > &)
	Construct by transferring the parameter contents.
	~HashTable ()
label	size () const
	Return number of elements in table.
bool	empty () const
	Return true if the hash table is empty.
bool	found (const Key &) const
	Return true if hashedEntry is found in table.
iterator	find (const Key &)
	Find and return an iterator set at the hashedEntry.
const_iterator	find (const Key &) const
	Find and return an const_iterator set at the hashedEntry.
List< Key >	toc () const
	Return the table of contents.
List< Key >	sortedToc () const
	Return the table of contents as a sorted list.
Ostream &	printInfo (Ostream &) const
	Print information.
bool	insert (const Key &, const T &newElmt)
	Insert a new hashedEntry.
bool	set (const Key &, const T &newElmt)
	Assign a new hashedEntry, overwriting existing entries.
bool	erase (const iterator &)
	Erase an hashedEntry specified by given iterator.
bool	erase (const Key &)
	Erase an hashedEntry specified by given key if in table.
label	erase (const UList< Key > &)
	Remove entries given by the listed keys from this HashTable.
template<class AnyType , class AnyHash >
label	erase (const HashTable< AnyType, Key, AnyHash > &)
	Remove entries given by the given keys from this HashTable.
void	resize (const label newSize)
	Resize the hash table for efficiency.
void	clear ()
	Clear all entries from table.
void	clearStorage ()
	Clear the table entries and the table itself.
void	transfer (HashTable< T, Key, Hash > &)
	Transfer the contents of the argument table into this table.
Xfer< HashTable< T, Key, Hash > >	xfer ()
	Transfer contents to the Xfer container.
T &	operator[] (const Key &)
	Find and return an hashedEntry.
const T &	operator[] (const Key &) const
	Find and return an hashedEntry.
T &	operator() (const Key &)
	Find and return an hashedEntry, create it null if not present.
void	operator= (const HashTable< T, Key, Hash > &)
	Assignment.
bool	operator== (const HashTable< T, Key, Hash > &) const
	Equality. Two hash tables are equal if all contents of first are.
bool	operator!= (const HashTable< T, Key, Hash > &) const
	The opposite of the equality operation. Takes linear time.
iterator	begin ()
	iterator set to the begining of the HashTable
const iterator &	end ()
	iterator set to beyond the end of the HashTable
const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable
const const_iterator &	cend () const
	const_iterator set to beyond the end of the HashTable
const_iterator	begin () const
	const_iterator set to the beginning of the HashTable
const const_iterator &	end () const
	const_iterator set to beyond the end of the HashTable
Friends
class	HashPtrTable
	Declare friendship with the HashPtrTable class.
class	iterator
class	const_iterator
Istream &	operator>> (Istream &, HashTable< T, Key, Hash > &)
Ostream &	operator (Ostream &, const HashTable< T, Key, Hash > &)

Member Typedef Documentation

typedef T value_type

Type of values the HashTable contains.

Definition at line 276 of file HashTable.H.

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 280 of file HashTable.H.

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 285 of file HashTable.H.

typedef label size_type

The type that can represent the size of a HashTable.

Definition at line 288 of file HashTable.H.

Constructor & Destructor Documentation

HashTable ( const label size = 128 )

Construct given initial table size.

Definition at line 62 of file HashTable.C.

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 ( const HashTable< T, Key, Hash > & ht )

Construct as copy.

Definition at line 84 of file HashTable.C.

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

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

Construct by transferring the parameter contents.

Definition at line 111 of file HashTable.C.

~HashTable ( )

Definition at line 129 of file HashTable.C.

References clear().

Member Function Documentation

Foam::label size ( ) const [inline]

Return number of elements in table.

Reimplemented in Cloud< ParticleType >, triSurfaceMesh, surfMesh, Cloud< BasicReactingMultiphaseParcel< ThermoType > >, Cloud< basicThermoParcel >, Cloud< indexedParticle >, Cloud< trackedParticle >, Cloud< ParcelType >, Cloud< parcel >, Cloud< basicKinematicParcel >, Cloud< solidParticle >, Cloud< CoalParcel< ThermoType > >, Cloud< molecule >, Cloud< passiveParticle >, Cloud< dsmcParcel >, and Cloud< BasicReactingParcel< ThermoType > >.

Definition at line 58 of file HashTableI.H.

Referenced by autoLayerDriver::addLayers(), meshRefinement::baffleAndSplitMesh(), cellToFaceStencil::calcFaceStencil(), boundaryMesh::changeFaces(), primitiveMesh::checkEdgeLength(), motionSmoother::checkMesh(), hexRef8::consistentSlowRefinement2(), autoSnapDriver::createZoneBaffles(), meshRefinement::dupNonManifoldPoints(), surfaceSets::getHangingCells(), combineFaces::getMergeSets(), removePoints::getUnrefimentSet(), globalPoints::globalPoints(), topoSet::invert(), meshRefinement::mergeEdges(), polyBoundaryMesh::neighbourEdges(), boundaryMesh::patchify(), Foam::polyMeshZipUpCells(), boundaryMesh::readTriSurface(), motionSmoother::scaleMesh(), fvMeshSubset::setCellSubset(), removePoints::setRefinement(), duplicatePoints::setRefinement(), boundaryCutter::setRefinement(), hexRef8::setUnrefinement(), UnsortedMeshedSurface< Face >::sortedZones(), topoSet::subset(), edgeVertex::updateLabels(), and STARCD::writeSurface().

bool empty ( ) const [inline]

Return true if the hash table is empty.

Definition at line 65 of file HashTableI.H.

bool found ( const Key & key ) const

Return true if hashedEntry is found in table.

Definition at line 142 of file HashTable.C.

References Foam::Info.

Referenced by setToPointZone::applyToSet(), setToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), faceZoneToFaceZone::applyToSet(), setToCellZone::applyToSet(), cellModeller::cellModeller(), surfaceFormatsCore::checkSupport(), speciesTable::contains(), motionSmoother::correctBoundaryConditions(), cellDistFuncs::correctBoundaryFaceCells(), cellDistFuncs::correctBoundaryPointCells(), geomCellLooper::cut(), HashTable< T, Key, Hash >::erase(), surfaceSets::getHangingCells(), removePoints::getUnrefimentSet(), topoSet::invert(), cellFeatures::isFeatureEdge(), fvMeshAdder::MapSurfaceFields(), fvMeshAdder::MapVolFields(), cellDistFuncs::maxPatchSize(), UnsortedMeshedSurface< Face >::New(), MeshedSurface< Face >::New(), argList::optionFound(), STARCD::readBoundary(), fvMeshSubset::setCellSubset(), motionSmoother::setDisplacement(), cellDistFuncs::sumPatchSize(), surfaceIntersection::surfaceIntersection(), topoSetSource::usage(), UnsortedMeshedSurface< Face >::write(), and MeshedSurface< Face >::write().

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

References Foam::Info.

Referenced by dictionary::add(), cellTable::addCellZones(), faceZoneSet::addSet(), extendedCellToFaceStencil::calcDistributeMap(), enrichedPatch::calcEnrichedFaces(), cellMatcher::calcLocalFaces(), dictionary::changeKeyword(), primitiveMesh::checkFaceFaces(), objectRegistry::checkOut(), cyclicPolyPatch::coupledEdges(), autoSnapDriver::createZoneBaffles(), meshRefinement::decomposeCombineRegions(), faceZoneSet::deleteSet(), polyMeshAdder::findSharedPoints(), combineFaces::getMergeSets(), autoSnapDriver::getZoneSurfacePoints(), fvMeshSubset::interpolate(), cellModeller::lookup(), DictionaryBase< IDLListType, T >::lookup(), dictionary::lookupEntryPtr(), DictionaryBase< IDLListType, T >::lookupPtr(), dictionary::merge(), polyMeshAdder::mergePoints(), slidingInterface::modifyMotionPoints(), attachDetach::modifyMotionPoints(), polyBoundaryMesh::neighbourEdges(), HashTable< T, Key, Hash >::operator()(), HashTable< T, Key, Hash >::operator==(), HashTable< T, Key, Hash >::operator[](), STARCDsurfaceFormat< Face >::read(), OBJsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), STARCD::readBoundary(), Foam::ReadFields(), dictionary::remove(), DictionaryBase< IDLListType, T >::remove(), undoableMeshCutter::removeSplitFaces(), genericPointPatchField< Type >::rmap(), genericFvPatchField< Type >::rmap(), duplicatePoints::setRefinement(), undoableMeshCutter::setRefinement(), boundaryCutter::setRefinement(), combineFaces::setUnrefinement(), UnsortedMeshedSurface< Face >::sortedZones(), faceZoneSet::subset(), syncTools::syncEdgeMap(), hexRef8::updateMesh(), meshReader::warnDuplicates(), cellZone::whichCell(), faceZone::whichFace(), PrimitivePatch< Face, FaceList, PointField, PointType >::whichPoint(), pointZone::whichPoint(), and ZoneMesh< ZoneType, MeshType >::whichZone().

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

References Foam::Info.

Foam::List< Key > toc ( ) const

Return the table of contents.

Definition at line 235 of file HashTable.C.

Referenced by extendedCellToFaceStencil::calcDistributeMap(), cellToFaceStencil::calcFaceCells(), cellToCellStencil::calcFaceCells(), surfaceFormatsCore::checkSupport(), patchDataWave< TransferType >::correct(), meshRefinement::createBaffles(), octree< Type >::findBox(), triSurfaceTools::getVertexVertices(), attachDetach::modifyMotionPoints(), HashTable< T, Key, Hash >::operator[](), Foam::polyMeshZipUpCells(), TimeActivatedExplicitSource< Type >::setCellSet(), basicSource::setCellSet(), fvMeshSubset::setCellSubset(), and explicitSource::setSelectedCellsFromPoints().

Foam::List< Key > sortedToc ( ) const

Return the table of contents as a sorted list.

Definition at line 250 of file HashTable.C.

References Foam::sort().

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

Print information.

Definition at line 55 of file HashTableIO.C.

References Foam::endl().

bool insert	(	const Key &	key,
		const T &	newElmt
	)		`[inline]`

Insert a new hashedEntry.

Definition at line 73 of file HashTableI.H.

Referenced by timeSelector::addOptions(), topoSetSource::addToUsageTable::addToUsageTable(), mpiPstreamImpl::addValidParOptions(), cellModeller::cellModeller(), primitiveMesh::checkFaceFaces(), objectRegistry::checkIn(), cellDistFuncs::correctBoundaryFaceCells(), cellDistFuncs::correctBoundaryPointCells(), cyclicGAMGInterface::cyclicGAMGInterface(), polyMeshAdder::findSharedPoints(), HashTable< T, Key, Hash >::HashTable(), addSubtract::init(), objectRegistry::lookupClass(), IOobjectList::lookupClass(), polyBoundaryMesh::neighbourEdges(), HashTable< T, Key, Hash >::operator()(), cellTable::operator=(), processorGAMGInterface::processorGAMGInterface(), STARCDsurfaceFormat< Face >::read(), OBJsurfaceFormat< Face >::read(), NASsurfaceFormat< Face >::read(), functionObjectList::read(), STARCD::readBoundary(), boundaryMesh::readTriSurface(), HashTable< T, Key, Hash >::resize(), fvMeshSubset::setCellSubset(), removePoints::setRefinement(), combineFaces::setRefinement(), combineFaces::setUnrefinement(), UnsortedMeshedSurface< Face >::sortedZones(), and meshReader::warnDuplicates().

bool set	(	const Key &	key,
		const T &	newElmt
	)		`[inline]`

Assign a new hashedEntry, overwriting existing entries.

Definition at line 84 of file HashTableI.H.

bool erase ( const iterator & cit )

Erase an hashedEntry specified by given iterator.

Definition at line 345 of file HashTable.C.

References Foam::Info.

Referenced by objectRegistry::checkOut(), polyBoundaryMesh::neighbourEdges(), Foam::ReadFields(), and HashPtrTable< T, Key, Hash >::remove().

bool erase ( const Key & key )

Erase an hashedEntry specified by given key if in table.

Definition at line 428 of file HashTable.C.

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

References forAll.

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

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.

Definition at line 467 of file HashTable.C.

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

void resize ( const label newSize )