A HashTable to objects of type <T> with a label key. More...

Inheritance diagram for Map< T >:

[legend]

Collaboration diagram for Map< T >:

Public Types
typedef Map< T >	this_type
	The template instance used for this Map. More...

typedef HashTable< T, label, Hash< label > >	parent_type
	The template instance used for the parent HashTable. More...

using	iterator = typename parent_type::iterator

using	const_iterator = typename parent_type::const_iterator

Public Types inherited from HashTable< T, label, Hash< label > >
typedef HashTable< T, label, Hash< label > >	this_type
	The template instance used for this HashTable. More...

using	node_type = std::conditional_t< std::is_same_v< Foam::zero, std::remove_cv_t< T > >, Detail::HashTableSingle< label >, Detail::HashTablePair< label, T > >
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More...

typedef label	key_type
	The second template parameter, type of keys used. More...

typedef T	mapped_type
	The first template parameter, type of objects contained. More...

typedef T	value_type
	Same as mapped_type for OpenFOAM HashTables. More...

typedef Hash< label >	hasher
	The third template parameter, the hash index method. More...

typedef T *	pointer
	Pointer type for storing into value_type objects. More...

typedef T &	reference
	Reference to the stored value_type. More...

typedef const T *	const_pointer
	Const pointer type for the stored value_type. More...

typedef const T &	const_reference
	Const 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
constexpr	Map () noexcept=default
	Default construct: empty without allocation (capacity=0) More...

constexpr	Map (Foam::zero) noexcept
	Construct empty without allocation (capacity=0) More...

	Map (const label initialCapacity)
	Construct empty with given initial table capacity. More...

	Map (Istream &is)
	Construct from Istream (with default initial table capacity) More...

	Map (const this_type &map)
	Copy construct. More...

	Map (this_type &&map) noexcept
	Move construct. More...

	Map (std::initializer_list< std::pair< label, T >> map, const bool overwrite=false)
	Construct from key/value pairs in initializer list. More...

	Map (const UList< label > &keys, const UList< T > &values, const bool overwrite=false)
	Construct from key/value pairs. More...

void	operator= (const this_type &rhs)
	Copy assignment. More...

void	operator= (this_type &&rhs)
	Move assignment. More...

Public Member Functions inherited from HashTable< T, label, Hash< label > >
constexpr	HashTable () noexcept
	Default construct: empty without allocation (capacity=0) More...

constexpr	HashTable (Foam::zero) noexcept
	Construct empty without allocation (capacity=0) More...

	HashTable (const label initialCapacity)
	Construct empty with initial table capacity. More...

	HashTable (Istream &is)
	Construct from Istream. More...

	HashTable (const this_type &ht)
	Copy construct. More...

	HashTable (this_type &&rhs) noexcept
	Move construct. More...

	HashTable (std::initializer_list< std::pair< label, T >> list, const bool overwrite=false)
	Construct from key/value pairs in initializer list. More...

	HashTable (const UList< label > &keys, const UList< T > &values, const bool overwrite=false)
	Construct from key/value pairs. More...

	~HashTable ()
	Destructor. More...

bool	empty () const noexcept
	True if the hash table is empty. More...

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

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

T &	at (const label &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	at (const label &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

bool	contains (const label &key) const
	True if hashed key is contained (found) in table. More...

iterator	find (const label &key)
	Find and return an iterator set at the hashed entry. More...

const_iterator	find (const label &key) const
	Find and return an const_iterator set at the hashed entry. More...

const_iterator	cfind (const label &key) const
	Find and return an const_iterator set at the hashed entry. More...

const T &	lookup (const label &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default. More...

List< label >	toc () const
	The table of contents (the keys) in unsorted order. More...

List< label >	sortedToc () const
	The table of contents (the keys) in sorted order. More...

List< label >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator. More...

Foam::List< label >	sortedToc (const Compare &comp) const

List< label >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the keys. More...

Foam::List< label >	tocKeys (const UnaryPredicate &pred, const bool invert) const

List< label >	tocValues (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the values. More...

Foam::List< label >	tocValues (const UnaryPredicate &pred, const bool invert) const

List< label >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the binary predicate applied to the keys and values. More...

Foam::List< label >	tocEntries (const BinaryPredicate &pred, const bool invert) const

UPtrList< const node_type >	csorted () const
	Const access to the hash-table contents in sorted order (sorted by keys). More...

UPtrList< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys). More...

UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method. More...

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 label &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...

bool	emplace_set (const label &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries. More...

bool	insert (const label &key, const T &obj)
	Copy insert a new entry, not overwriting existing entries. More...

bool	insert (const label &key, T &&obj)
	Move insert a new entry, not overwriting existing entries. More...

bool	set (const label &key, const T &obj)
	Copy assign a new entry, overwriting existing entries. More...

bool	set (const label &key, T &&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 label &key)
	Erase an entry specified by the given key. More...

label	erase (const HashTable< AnyType, label, AnyHash > &other)
	Remove table entries given by keys of the other hash-table. More...

label	erase (std::initializer_list< label > 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< label, N > &keys)
	Remove table entries given by the listed keys. More...

label	erase (const UList< label > &keys)
	Remove table entries given by the listed keys. More...

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

Foam::label	erase (const FixedList< label, N > &keys)

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

label	retain (const HashTable< AnyType, label, AnyHash > &other)
	Retain table entries given by keys of the other hash-table. More...

Foam::label	retain (const HashTable< AnyType, label, 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	clear ()
	Remove all entries from table. More...

void	clearStorage ()
	Remove all entries from table and the table itself. More...

void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets). More...

void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity() More...

void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. More...

void	swap (HashTable< T, label, Hash< label > > &rhs) noexcept
	Swap contents into this table. More...

void	transfer (HashTable< T, label, Hash< label > > &rhs)
	Transfer contents into this table. More...

void	merge (HashTable< T, label, Hash< label > > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

void	merge (HashTable< T, label, Hash< label > > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged. More...

T &	operator[] (const label &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const T &	operator[] (const label &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

T &	operator() (const label &key)
	Return existing entry or create a new entry. More...

T &	operator() (const label &key, const T &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< label, T >> rhs)
	Copy assign from an initializer list. More...

void	operator= (this_type &&rhs)
	Move assign. More...

bool	operator== (const this_type &rhs) const
	Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. More...

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
	Write unordered keys (list), with line-breaks when length exceeds shortLen. More...

bool	found (const label &key) const
	Same as contains() More...

Public Member Functions inherited from HashTableCore
	ClassName ("HashTable")
	Declare type-name (with debug switch) More...

constexpr	HashTableCore () noexcept=default
	Default construct. More...

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

Static Public Attributes inherited from HashTableCore
static const label	maxTableSize
	Maximum allowable internal table size. Approximately labelMax/4. More...

Detailed Description

template<class T>
class Foam::Map< T >

A HashTable to objects of type <T> with a label key.

Note: The Map contents are unordered. When the key order is important, use the sortedToc() method to obtain a list of sorted keys and use that for further access.

See also: PtrMap

Definition at line 51 of file Map.H.

Member Typedef Documentation

◆ this_type

typedef Map<T> this_type

The template instance used for this Map.

Definition at line 60 of file Map.H.

◆ parent_type

typedef HashTable<T, label, Hash<label> > parent_type

The template instance used for the parent HashTable.

Definition at line 65 of file Map.H.

◆ iterator

using iterator = typename parent_type::iterator

Definition at line 67 of file Map.H.

◆ const_iterator

using const_iterator = typename parent_type::const_iterator

Definition at line 68 of file Map.H.

Constructor & Destructor Documentation

◆ Map() [1/8]

constexpr Map ( )

constexprdefaultnoexcept

Default construct: empty without allocation (capacity=0)

◆ Map() [2/8]

constexpr Map ( Foam::zero )

inlineexplicitconstexprnoexcept

Construct empty without allocation (capacity=0)

Definition at line 81 of file Map.H.

◆ Map() [3/8]

Map ( const label initialCapacity )

inlineexplicit

Construct empty with given initial table capacity.

Definition at line 86 of file Map.H.

◆ Map() [4/8]

Map ( Istream & is )

inline

Construct from Istream (with default initial table capacity)

Definition at line 94 of file Map.H.

◆ Map() [5/8]

Map ( const this_type & map )

inline

Copy construct.

Definition at line 102 of file Map.H.

◆ Map() [6/8]

Map ( this_type && map )

inlinenoexcept

Move construct.

Definition at line 110 of file Map.H.

◆ Map() [7/8]

Map	(	std::initializer_list< std::pair< label, T >>	map,
		const bool	overwrite = `false`
	)

inline

Construct from key/value pairs in initializer list.

By default, uses insert not overwrite semantics for duplicates.

Definition at line 120 of file Map.H.

◆ Map() [8/8]

Map	(	const UList< label > &	keys,
		const UList< T > &	values,
		const bool	overwrite = `false`
	)

inline

Construct from key/value pairs.

By default, uses insert not overwrite semantics for duplicates.

Definition at line 134 of file Map.H.

Member Function Documentation

◆ operator=() [1/2]

void operator= ( const this_type & rhs )

inline

Copy assignment.

Definition at line 152 of file Map.H.

References HashTable< T, label, Hash< label > >::operator=().

Referenced by IOMap< T >::IOMap(), boundaryRegion::operator=(), cellTable::operator=(), distribution::operator=(), and IOMap< T >::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/2]

void operator= ( this_type && rhs )

inline

Move assignment.

Definition at line 160 of file Map.H.

References HashTable< T, label, Hash< label > >::operator=().

Here is the call graph for this function:

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

src/lumpedPointMotion/controller/lumpedPointController.H
src/OpenFOAM/containers/HashTables/Map/Map.H

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class Foam::Map< T >

Member Typedef Documentation

◆ this_type

◆ parent_type

◆ iterator

◆ const_iterator

Constructor & Destructor Documentation

◆ Map() [1/8]

◆ Map() [2/8]

◆ Map() [3/8]

◆ Map() [4/8]

◆ Map() [5/8]

◆ Map() [6/8]

◆ Map() [7/8]

◆ Map() [8/8]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]

template<class T>
class Foam::Map< T >