A HashTable of pointers to objects of type <T>, with deallocation management of the pointers. More...

#include <HashPtrTable.H>

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

[legend]

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

Public Types
typedef HashPtrTable< T, Key, Hash >	this_type
	The template instance used for this table.
typedef HashTable< T *, Key, Hash >	parent_type
	The template instance used for the parent HashTable.
using	iterator = typename parent_type::iterator
using	const_iterator = typename parent_type::const_iterator
Public Types inherited from HashTable< T, Key, Hash >
typedef HashTable< T, Key, Hash >	this_type
	The template instance used for this HashTable.
using	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions.
typedef Key	key_type
	The second template parameter, type of keys used.
typedef T	mapped_type
	The first template parameter, type of objects contained.
typedef T	value_type
	Same as mapped_type for OpenFOAM HashTables.
typedef Hash	hasher
	The third template parameter, the hash index method.
typedef T *	pointer
	Pointer type for storing into value_type objects.
typedef T &	reference
	Reference to the stored value_type.
typedef const T *	const_pointer
	Const pointer type for the stored value_type.
typedef const T &	const_reference
	Const reference to the stored value_type.
typedef label	difference_type
	The type to represent the difference between two iterators.
typedef label	size_type
	The type that can represent the size of a HashTable.
using	key_iterator = key_iterator_base<iterator>
	Forward iterator returning the key.
using	const_key_iterator = key_iterator_base<const_iterator>
	Forward const iterator returning the key.

Public Member Functions
constexpr	HashPtrTable () noexcept=default
	Default construct: empty without allocation (capacity=0).
constexpr	HashPtrTable (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashPtrTable (const label initialCapacity)
	Construct given initial table capacity.
	HashPtrTable (const this_type &rhs)
	Copy construct, making a copy of each element.
	HashPtrTable (this_type &&rhs) noexcept
	Move construct.
template<class INew>
	HashPtrTable (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class.
	HashPtrTable (Istream &is)
	Construct from Istream using default Istream constructor class.
	HashPtrTable (const dictionary &dict)
	Construct from dictionary with default dictionary constructor class.
	~HashPtrTable ()
	Destructor.
const T *	test (const Key &key) const
	Return const pointer associated with given entry or a nullptr if the key does not exist in the table.
const T *	get (const Key &key) const
	Return const pointer associated with given entry or a nullptr if the key does not exist in the table.
T *	get (const Key &key)
	Return pointer associated with given entry or a nullptr if the key does not exist in the table.
autoPtr< T >	release (iterator &iter)
	Release ownership of the pointer and replace with a nullptr.
autoPtr< T >	release (const Key &key)
	Release ownership of the pointer and replace with a nullptr.
autoPtr< T >	remove (iterator &iter)
	Remove entry specified by given iterator.
autoPtr< T >	remove (const Key &key)
	Remove entry specified by given key.
bool	erase (iterator &iter)
	Erase entry specified by given iterator and delete the allocated pointer.
bool	erase (const Key &key)
	Erase entry specified by given key and delete the allocated pointer.
void	clear ()
	Clear all entries from table and delete any allocated pointers.
void	merge (HashPtrTable< T, Key, Hash > &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.
void	merge (HashPtrTable< T, Key, Hash > &&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.
void	write (Ostream &os) const
	Invoke write() on each non-null entry.
void	operator= (const this_type &rhs)
	Copy assignment.
void	operator= (this_type &&rhs)
	Move assignment.
template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries.
template<class... Args>
T &	emplace_set (const Key &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries.
template<class... Args>
T &	try_emplace (const Key &key, Args &&... args)
	Like emplace_set() but will not overwrite an occupied (non-null) location.
bool	insert (const Key &, T *)=delete
	No insert() with raw pointers (potential memory leaks). Use insert() with autoPtr or set().
bool	insert (const Key &key, std::unique_ptr< T > &&ptr)
	Insert a new entry, not overwriting existing entries.
bool	insert (const Key &key, autoPtr< T > &&ptr)
	Insert a new entry, not overwriting existing entries.
bool	set (const Key &key, T *ptr)
	Assign a new entry, overwrites existing.
bool	set (const Key &key, std::unique_ptr< T > &&ptr)
	Assign a new entry, overwrites existing.
bool	set (const Key &key, autoPtr< T > &&ptr)
	Assign a new entry, overwrites existing.
bool	set (const Key &key, const refPtr< T > &ptr)
	Assign a new entry from refPtr (move or clone), overwrites existing.
bool	set (const Key &key, const tmp< T > &ptr)
	Assign a new entry from tmp (move or clone), overwrites existing.
bool	insert (const Key &key, autoPtr< T > &ptr)
	Insert a new entry, not overwriting existing entries.
bool	set (const Key &key, autoPtr< T > &ptr)
	Assign a new entry, overwrites existing.
Public Member Functions inherited from HashTable< T, Key, Hash >
constexpr	HashTable () noexcept
	Default construct: empty without allocation (capacity=0).
constexpr	HashTable (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashTable (const label initialCapacity)
	Construct empty with initial table capacity.
	HashTable (Istream &is)
	Construct from Istream.
	HashTable (const this_type &ht)
	Copy construct.
	HashTable (this_type &&rhs) noexcept
	Move construct.
	HashTable (std::initializer_list< std::pair< Key, T > > list, const bool overwrite=false)
	Construct from key/value pairs in initializer list.
	HashTable (const UList< Key > &keys, const UList< T > &values, const bool overwrite=false)
	Construct from key/value pairs.
	~HashTable ()
	Destructor.
bool	empty () const noexcept
	True if the hash table is empty.
label	size () const noexcept
	The number of elements in table.
label	capacity () const noexcept
	The size of the underlying table (the number of buckets).
T &	at (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
bool	contains (const Key &key) const
	True if hashed key is contained (found) in table.
iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry.
const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const T &	lookup (const Key &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default.
List< Key >	toc () const
	The table of contents (the keys) in unsorted order.
List< Key >	sortedToc () const
	The table of contents (the keys) in sorted order.
template<class Compare>
List< Key >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator.
template<class UnaryPredicate>
List< Key >	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.
template<class UnaryPredicate>
List< Key >	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.
template<class BinaryPredicate>
List< Key >	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.
UPtrList< const node_type >	csorted () const
	Const access to the hash-table contents in sorted order (sorted by keys).
UPtrList< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys).
template<class UnaryPredicate>
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate.
template<class UnaryPredicate>
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate.
template<class BinaryPredicate>
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate.
template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries.
template<class... Args>
bool	emplace_set (const Key &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries.
bool	insert (const Key &key, const T &obj)
	Copy insert a new entry, not overwriting existing entries.
bool	insert (const Key &key, T &&obj)
	Move insert a new entry, not overwriting existing entries.
bool	set (const Key &key, const T &obj)
	Copy assign a new entry, overwriting existing entries.
bool	set (const Key &key, T &&obj)
	Move assign a new entry, overwriting existing entries.
bool	erase (const iterator &iter)
	Erase an entry specified by given iterator.
bool	erase (const Key &key)
	Erase an entry specified by the given key.
template<class AnyType, class AnyHash>
label	erase (const HashTable< AnyType, Key, AnyHash > &other)
	Remove table entries given by keys of the other hash-table.
label	erase (std::initializer_list< Key > keys)
	Remove table entries given by the listed keys.
template<class InputIter>
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys.
template<unsigned N>
label	erase (const FixedList< Key, N > &keys)
	Remove table entries given by the listed keys.
label	erase (const UList< Key > &keys)
	Remove table entries given by the listed keys.
template<class AnyType, class AnyHash>
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table.
template<class UnaryPredicate>
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys.
template<class UnaryPredicate>
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values.
template<class BinaryPredicate>
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value.
void	clear ()
	Remove all entries from table.
void	clearStorage ()
	Remove all entries from table and the table itself.
void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets).
void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity().
void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table.
void	swap (HashTable< T, Key, Hash > &rhs) noexcept
	Swap contents into this table.
void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table.
void	merge (HashTable< T, Key, Hash > &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.
void	merge (HashTable< T, Key, Hash > &&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.
T &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
T &	operator() (const Key &key)
	Return existing entry or create a new entry.
T &	operator() (const Key &key, const T &deflt)
	Return existing entry or insert a new entry.
void	operator= (const this_type &rhs)
	Copy assign.
void	operator= (std::initializer_list< std::pair< Key, T > > rhs)
	Copy assign from an initializer list.
void	operator= (this_type &&rhs)
	Move assign.
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.
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation.
this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable.
const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys.
iterator	begin ()
	iterator set to the beginning of the HashTable
const_iterator	begin () const
	const_iterator set to the beginning of the HashTable
const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable
iterator	end () noexcept
	iterator to signal the end (for any HashTable)
const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable)
constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable)
Ostream &	printInfo (Ostream &os) const
	Print information.
Ostream &	writeKeys (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen.
bool	found (const Key &key) const
	Same as contains().
UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method.
template<class Compare>
Foam::List< Key >	sortedToc (const Compare &comp) const
template<class UnaryPredicate>
Foam::List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert) const
template<class UnaryPredicate>
Foam::List< Key >	tocValues (const UnaryPredicate &pred, const bool invert) const
template<class BinaryPredicate>
Foam::List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert) const
template<class UnaryPredicate>
Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const
template<class UnaryPredicate>
Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const
template<class BinaryPredicate>
Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const
template<class InputIter>
Foam::label	erase (InputIter first, InputIter last)
template<unsigned N>
Foam::label	erase (const FixedList< Key, N > &keys)
template<class AnyType, class AnyHash>
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &other)
template<class AnyType, class AnyHash>
Foam::label	retain (const HashTable< AnyType, Key, AnyHash > &other)
template<class UnaryPredicate>
Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)
template<class UnaryPredicate>
Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)
template<class BinaryPredicate>
Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)
Public Member Functions inherited from HashTableCore
	ClassName ("HashTable")
	Declare type-name (with debug switch).
constexpr	HashTableCore () noexcept=default
	Default construct.

Friends
Istream &	operator>> (Istream &is, HashPtrTable< T, Key, Hash > &tbl)
	Clear table and read from Istream.

Additional Inherited Members
Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label size) noexcept
	Return a canonical (power-of-two) of the requested size.
Static Public Attributes inherited from HashTableCore
static constexpr int32_t	maxTableSize = (1 << (32-3))
	Maximum allowable internal table size (must be a power of two!).

Detailed Description

template<class T, class Key = word, class Hash = Foam::Hash<Key>>
class Foam::HashPtrTable< T, Key, Hash >

A HashTable of pointers to objects of type <T>, with deallocation management of the pointers.

Source files

Definition at line 62 of file HashPtrTable.H.

Member Typedef Documentation

◆ this_type

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

typedef HashPtrTable<T, Key, Hash> this_type

The template instance used for this table.

Definition at line 96 of file HashPtrTable.H.

◆ parent_type

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

typedef HashTable<T*, Key, Hash> parent_type

The template instance used for the parent HashTable.

Definition at line 101 of file HashPtrTable.H.

◆ iterator

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

using iterator = typename parent_type::iterator

Definition at line 103 of file HashPtrTable.H.

◆ const_iterator

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

using const_iterator = typename parent_type::const_iterator

Definition at line 104 of file HashPtrTable.H.

Constructor & Destructor Documentation

◆ HashPtrTable() [1/8]

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

HashPtrTable ( )

constexprdefaultnoexcept

Default construct: empty without allocation (capacity=0).

Referenced by merge().

Here is the caller graph for this function:

◆ HashPtrTable() [2/8]

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

HashPtrTable ( Foam::zero )

inlineexplicitconstexprnoexcept

Construct empty without allocation (capacity=0).

Definition at line 117 of file HashPtrTable.H.

◆ HashPtrTable() [3/8]

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

HashPtrTable ( const label initialCapacity )

inlineexplicit

Construct given initial table capacity.

Definition at line 122 of file HashPtrTable.H.

◆ HashPtrTable() [4/8]

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

HashPtrTable ( const this_type & rhs )

Copy construct, making a copy of each element.

◆ HashPtrTable() [5/8]

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

HashPtrTable ( this_type && rhs )

inlinenoexcept

Move construct.

Definition at line 135 of file HashPtrTable.H.

◆ HashPtrTable() [6/8]

template<class T, class Key, class Hash>

template<class INew>

HashPtrTable	(	Istream &	is,
		const INew &	inew )

Construct from Istream using given Istream constructor class.

Definition at line 152 of file HashPtrTableIO.C.

◆ HashPtrTable() [7/8]

template<class T, class Key, class Hash>

HashPtrTable ( Istream & is )

Construct from Istream using default Istream constructor class.

Definition at line 159 of file HashPtrTableIO.C.

◆ HashPtrTable() [8/8]

template<class T, class Key, class Hash>

HashPtrTable ( const dictionary & dict )

explicit

Construct from dictionary with default dictionary constructor class.

Definition at line 166 of file HashPtrTableIO.C.

References dict.

◆ ~HashPtrTable()

template<class T, class Key, class Hash>

~HashPtrTable ( )

Destructor.

Definition at line 56 of file HashPtrTable.C.

References clear().

Here is the call graph for this function:

Member Function Documentation

◆ test()

template<class T, class Key, class Hash>

const T * test ( const Key & key ) const

inline

Return const pointer associated with given entry or a nullptr if the key does not exist in the table.

Definition at line 28 of file HashPtrTableI.H.

References HashTable< T, Key, Hash >::cfind(), and Foam::T().

Here is the call graph for this function:

◆ get() [1/2]

template<class T, class Key, class Hash>

const T * get ( const Key & key ) const

inline

Return const pointer associated with given entry or a nullptr if the key does not exist in the table.

Definition at line 41 of file HashPtrTableI.H.

References HashTable< T, Key, Hash >::cfind(), and Foam::T().

Referenced by filmTurbulenceModel::primaryRegionFriction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get() [2/2]

template<class T, class Key, class Hash>

T * get ( const Key & key )

inline

Return pointer associated with given entry or a nullptr if the key does not exist in the table.

Definition at line 54 of file HashPtrTableI.H.

References HashTable< T, Key, Hash >::find(), and Foam::T().

Here is the call graph for this function:

◆ release() [1/2]

template<class T, class Key, class Hash>

Foam::autoPtr< T > release ( iterator & iter )

Release ownership of the pointer and replace with a nullptr.

Includes a safeguard against the end-iterator.

Returns: the entry's old value as an encapsulated pointer.

Definition at line 65 of file HashPtrTable.C.

Referenced by release().

Here is the caller graph for this function:

◆ release() [2/2]

template<class T, class Key, class Hash>

Foam::autoPtr< T > release ( const Key & key )

Release ownership of the pointer and replace with a nullptr.

Returns: the entry's old value as an encapsulated pointer.

Definition at line 79 of file HashPtrTable.C.

References HashTable< T, Key, Hash >::find(), and release().

Here is the call graph for this function:

◆ remove() [1/2]

template<class T, class Key, class Hash>

Foam::autoPtr< T > remove ( iterator & iter )

Remove entry specified by given iterator.

Includes a safeguard against the end-iterator.

Returns: the entry's old value as an encapsulated pointer.

Definition at line 87 of file HashPtrTable.C.

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

Referenced by remove().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove() [2/2]

template<class T, class Key, class Hash>

Foam::autoPtr< T > remove ( const Key & key )

Remove entry specified by given key.

Returns: the entry's old value as an encapsulated pointer.

Definition at line 101 of file HashPtrTable.C.

References HashTable< T, Key, Hash >::find(), and remove().

Here is the call graph for this function:

◆ erase() [1/2]

template<class T, class Key, class Hash>

bool erase ( iterator & iter )

Erase entry specified by given iterator and delete the allocated pointer.

Includes a safeguard against the end-iterator.

Returns: True if item was removed

Definition at line 109 of file HashPtrTable.C.

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

Here is the call graph for this function:

◆ erase() [2/2]

template<class T, class Key, class Hash>

bool erase ( const Key & key )

Erase entry specified by given key and delete the allocated pointer.

Returns: True if item was removed

Definition at line 127 of file HashPtrTable.C.

References erase(), and HashTable< T, Key, Hash >::find().

Here is the call graph for this function:

◆ clear()

template<class T, class Key, class Hash>

void clear ( )

Clear all entries from table and delete any allocated pointers.

Definition at line 135 of file HashPtrTable.C.

References HashTable< T, Key, Hash >::begin(), HashTable< T *, Key, Hash >::clear(), and HashTable< T, Key, Hash >::end().

Here is the call graph for this function:

◆ merge() [1/2]

template<class T, class Key, class Hash>

void merge ( HashPtrTable< T, Key, Hash > & 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.

Definition at line 147 of file HashPtrTable.C.

References HashPtrTable(), and HashTable< T *, Key, Hash >::merge().

Here is the call graph for this function:

◆ merge() [2/2]

template<class T, class Key, class Hash>

void merge ( HashPtrTable< T, Key, Hash > && 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.

Definition at line 159 of file HashPtrTable.C.

◆ write()

template<class T, class Key, class Hash>

void write ( Ostream & os ) const

Invoke write() on each non-null entry.

Definition at line 135 of file HashPtrTableIO.C.

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

Here is the call graph for this function:

◆ operator=() [1/2]

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

void operator= ( const this_type & rhs )

Copy assignment.

◆ operator=() [2/2]

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

void operator= ( this_type && rhs )

Move assignment.

◆ emplace()

template<class T, class Key, class Hash>

template<class... Args>

bool emplace	(	const Key &	key,
		Args &&...	args )

inline

Emplace insert a new entry, not overwriting existing entries.

Returns: True if the entry did not previously exist in the table.

Definition at line 68 of file HashPtrTableI.H.

References args, HashTable< T *, Key, Hash >::contains(), HashTable< T *, Key, Hash >::set(), and T.

Here is the call graph for this function:

◆ emplace_set()

template<class T, class Key, class Hash>

template<class... Args>

T & emplace_set	(	const Key &	key,
		Args &&...	args )

inline

Emplace set an entry, overwriting any existing entries.

Parameters

key	- the location to set
args	arguments to forward to the constructor of the element

Returns: reference to the new element.

Definition at line 121 of file HashPtrTableI.H.

References args, and Foam::T().

Here is the call graph for this function:

◆ try_emplace()

template<class T, class Key, class Hash>

template<class... Args>

T & try_emplace	(	const Key &	key,
		Args &&...	args )

inline

Like emplace_set() but will not overwrite an occupied (non-null) location.

Parameters

key	- the location to set (unless already defined)
args	arguments to forward to the constructor of the element

Returns: reference to the existing or the new element.

Definition at line 134 of file HashPtrTableI.H.

References args, and Foam::T().

Here is the call graph for this function:

◆ insert() [1/4]

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

bool insert	(	const Key &	,
		T *	)

inlinedelete

No insert() with raw pointers (potential memory leaks). Use insert() with autoPtr or set().

◆ insert() [2/4]

template<class T, class Key, class Hash>

bool insert	(	const Key &	key,
		std::unique_ptr< T > &&	ptr )

inline

Insert a new entry, not overwriting existing entries.

Returns: True if the entry inserted (not previously in table)

Definition at line 146 of file HashPtrTableI.H.

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

Here is the call graph for this function:

◆ insert() [3/4]

template<class T, class Key, class Hash>

bool insert	(	const Key &	key,
		autoPtr< T > &&	ptr )

inline

Insert a new entry, not overwriting existing entries.

Returns: True if the entry inserted (not previously in table)

Definition at line 163 of file HashPtrTableI.H.

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

Here is the call graph for this function:

◆ set() [1/6]

template<class T, class Key, class Hash>

bool set	(	const Key &	key,
		T *	ptr )

inline

Assign a new entry, overwrites existing.

Definition at line 180 of file HashPtrTableI.H.

References HashTable< T, Key, Hash >::find(), HashTable< T *, Key, Hash >::set(), and Foam::T().

Referenced by phaseSystem::addField(), exprResultGlobals::addValue(), exprResultGlobals::addValue(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), IOobjectList::lookupClassImpl(), IOobjectList::lookupClassTypeImpl(), IOobjectList::lookupImpl(), PhaseTransferPhaseSystem< BasePhaseSystem >::massTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), filmTurbulenceModel::primaryRegionFriction(), set(), set(), set(), set(), set(), liquidFilmBase::Up(), and liquidFilmBase::Uw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set() [2/6]

template<class T, class Key, class Hash>

bool set	(	const Key &	key,
		std::unique_ptr< T > &&	ptr )

inline

Assign a new entry, overwrites existing.

Definition at line 204 of file HashPtrTableI.H.

References set().

Here is the call graph for this function:

◆ set() [3/6]

template<class T, class Key, class Hash>

bool set	(	const Key &	key,
		autoPtr< T > &&	ptr )

inline

Assign a new entry, overwrites existing.

Definition at line 215 of file HashPtrTableI.H.

References set().

Here is the call graph for this function:

◆ set() [4/6]

template<class T, class Key, class Hash>

bool set	(	const Key &	key,
		const refPtr< T > &	ptr )

inline

Assign a new entry from refPtr (move or clone), overwrites existing.

Definition at line 226 of file HashPtrTableI.H.

References refPtr< T >::ptr(), and set().

Here is the call graph for this function:

◆ set() [5/6]

template<class T, class Key, class Hash>

bool set	(	const Key &	key,
		const tmp< T > &	ptr )

inline

Assign a new entry from tmp (move or clone), overwrites existing.

Definition at line 237 of file HashPtrTableI.H.

References tmp< T >::ptr(), and set().

Here is the call graph for this function:

◆ insert() [4/4]

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

bool insert	(	const Key &	key,
		autoPtr< T > &	ptr )

inline

Insert a new entry, not overwriting existing entries.

Returns: True if the entry inserted (not previously in table)

Definition at line 378 of file HashPtrTable.H.

◆ set() [6/6]

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

bool set	(	const Key &	key,
		autoPtr< T > &	ptr )

inline

Assign a new entry, overwrites existing.

Definition at line 386 of file HashPtrTable.H.

◆ operator>>

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

Istream & operator>>	(	Istream &	is,
		HashPtrTable< T, Key, Hash > &	tbl )

friend

Clear table and read from Istream.

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

src/OpenFOAM/containers/HashTables/HashPtrTable/HashPtrTable.H
src/OpenFOAM/containers/HashTables/HashPtrTable/HashPtrTable.C
src/OpenFOAM/containers/HashTables/HashPtrTable/HashPtrTableI.H
src/OpenFOAM/containers/HashTables/HashPtrTable/HashPtrTableIO.C

Public Types

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ this_type

◆ parent_type

◆ iterator

◆ const_iterator

Constructor & Destructor Documentation

◆ HashPtrTable() [1/8]

◆ HashPtrTable() [2/8]

◆ HashPtrTable() [3/8]

◆ HashPtrTable() [4/8]

◆ HashPtrTable() [5/8]

◆ HashPtrTable() [6/8]

◆ HashPtrTable() [7/8]

◆ HashPtrTable() [8/8]

◆ ~HashPtrTable()

Member Function Documentation

◆ test()

◆ get() [1/2]

◆ get() [2/2]

◆ release() [1/2]

◆ release() [2/2]

◆ remove() [1/2]

◆ remove() [2/2]

◆ erase() [1/2]

◆ erase() [2/2]

◆ clear()

◆ merge() [1/2]

◆ merge() [2/2]

◆ write()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ emplace()

◆ emplace_set()

◆ try_emplace()

◆ insert() [1/4]

◆ insert() [2/4]

◆ insert() [3/4]

◆ set() [1/6]

◆ set() [2/6]

◆ set() [3/6]

◆ set() [4/6]

◆ set() [5/6]

◆ insert() [4/4]

◆ set() [6/6]

Friends And Related Symbol Documentation

◆ operator>>