Dictionary< T > Class Template Reference

General purpose template dictionary class that manages the storage associated with it. More...

#include <Dictionary.H>

Inheritance diagram for Dictionary< T >:

Collaboration diagram for Dictionary< T >:

Public Types
typedef DictionaryBase< IDLList< T >, T >	dict_type
	The template instance used for the dictionary content.
Public Types inherited from UILList< DLListBase, T >
typedef T	value_type
	Type of values stored.
typedef T *	pointer
	Pointer for value_type.
typedef const T *	const_pointer
	Const pointer for value_type.
typedef T &	reference
	Reference for value_type.
typedef const T &	const_reference
	Const reference for value_type.
typedef label	size_type
	The type that can represent the container size.
typedef label	difference_type
	The difference between iterator objects.
using	base_iterator
using	const_base_iterator

Public Member Functions
	Dictionary (const label initialCapacity=128)
	Default construct, or with initial table capacity.
	Dictionary (const Dictionary &dict)
	Copy construct.
bool	erase (const word &keyword)
	Remove an entry specified by keyword and delete the pointer.
Public Member Functions inherited from DictionaryBase< IDLList< T >, T >
	DictionaryBase ()=default
	Default construct: empty without allocation (capacity=0).
	DictionaryBase (const label initialCapacity)
	Construct empty with initial table capacity.
	DictionaryBase (const DictionaryBase &dict)
	Copy construct.
	DictionaryBase (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class.
	DictionaryBase (Istream &is)
	Construct from Istream using default Istream constructor class.
bool	contains (const word &keyword) const
	Search for given keyword.
const T *	cfind (const word &keyword) const
	Find and return an entry, nullptr on failure.
T *	find (const word &keyword)
	Find and return an entry, nullptr on failure.
const T *	lookup (const word &keyword) const
	Find and return entry, FatalError on failure.
T *	lookup (const word &keyword)
	Find and return entry, FatalError on failure.
wordList	toc () const
	The table of contents (as a sorted list).
wordList	sortedToc () const
	The table of contents as a sorted list.
wordList	sortedToc (const Compare &comp) const
	The table of contents sorted using the specified comparator.
void	push_front (const word &keyword, T *ptr)
	Add to front of dictionary.
void	push_back (const word &keyword, T *ptr)
	Add to back of dictionary.
T *	remove (const word &keyword)
	Remove and return entry specified by keyword.
void	clear ()
	Clear the dictionary.
void	transfer (DictionaryBase< IDLList< T >, T > &dict)
	Transfer the contents of the argument into this DictionaryBase.
void	operator= (const DictionaryBase &)
	Copy assignment.
const T *	operator[] (const word &key) const
	Find and return entry.
T *	operator[] (const word &key)
	Find and return entry.
bool	found (const word &key) const
	Same as contains().
const T *	lookupPtr (const word &k) const
	Deprecated(2020-03) use cfind().
T *	lookupPtr (const word &k)
	Deprecated(2020-03) use find().
void	insert (const word &k, T *ptr)
	Add to front of dictionary.
void	prepend (const word &k, T *ptr)
	Add to front of dictionary.
void	append (const word &k, T *ptr)
	Add to back of dictionary.
Public Member Functions inherited from ILList< DLListBase, T >
	ILList ()=default
	Default construct.
	ILList (T *item)
	Construct and add initial item pointer.
	ILList (Istream &is)
	Construct from Istream.
	ILList (const ILList< DLListBase, T > &lst)
	Copy construct using the 'clone()' method for each element.
	ILList (ILList< DLListBase, T > &&lst)
	Move construct.
	ILList (const ILList< DLListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone 'clone()'.
	ILList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class.
	~ILList ()
	Destructor. Calls clear().
void	clear ()
	Clear the contents of the list.
void	pop_front (label n=1)
	Remove first element(s) from the list (deletes pointers).
bool	erase (T *item)
	Remove the specified element from the list and delete it.
void	transfer (ILList< DLListBase, T > &lst)
	Transfer the contents of the argument into this List and annul the argument list.
void	operator= (const ILList< DLListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element.
void	operator= (ILList< DLListBase, T > &&lst)
	Move assignment.
Public Member Functions inherited from UILList< DLListBase, T >
	UILList ()=default
	Default construct.
	UILList (T *item)
	Construct and add initial item pointer.
	UILList (const UILList< DLListBase, T > &list)
	Construct as copy.
T *	front ()
	The first entry in the list.
const T *	front () const
	The first entry in the list (const access).
T *	back ()
	The last entry in the list.
const T *	back () const
	The last entry in the list (const access).
T *	removeHead ()
	Remove and return head.
T *	remove (T *item)
	Remove and return element.
T *	remove (iterator &iter)
	Remove and return item specified by iterator.
void	operator= (const UILList< DLListBase, T > &lst)
	Copy assignment.
bool	operator== (const UILList< DLListBase, T > &lst) const
	Equality. True both lists are element-wise equal.
bool	operator!= (const UILList< DLListBase, T > &lst) const
	The opposite of the equality operation. Takes linear time.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write UILList with line-breaks when length exceeds shortLen.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
reverse_iterator	rbegin ()
	Iterator to last item in list with non-const access.
const_reverse_iterator	crbegin () const
	Iterator to last item in list with const access.
const_iterator	begin () const
	Iterator to first item in list with const access.
const_reverse_iterator	rbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for forward iterators.
const const_iterator &	cend () const
	End of list for forward iterators.
const reverse_iterator &	rend ()
	End of list for reverse iterators.
const const_reverse_iterator &	crend () const
	End of list for reverse iterators.
const const_iterator &	end () const
	End of list for forward iterators.
const const_reverse_iterator &	rend () const
	End of list for reverse iterators.
T *	first ()
	The first entry in the list.
const T *	first () const
	The first entry in the list (const access).
T *	last ()
	The last entry in the list.
const T *	last () const
	The last entry in the list (const access).
Public Member Functions inherited from DLListBase
	DLListBase ()=default
	Default construct.
	DLListBase (const DLListBase &)=delete
	No copy construct.
void	operator= (const DLListBase &)=delete
	No copy assignment.
	~DLListBase ()=default
	Destructor.
bool	empty () const noexcept
	True if the list is empty.
label	size () const noexcept
	The number of elements in list.
link *	front ()
	Return first entry.
const link *	front () const
	Return const access to first entry.
link *	back ()
	Return last entry.
const link *	back () const
	Return const access to last entry.
void	push_front (link *item)
	Add at front of list.
void	push_back (link *item)
	Add at back of list.
bool	swapUp (link *item)
	Swap this element with the one above unless it is at the top.
bool	swapDown (link *item)
	Swap this element with the one below unless it is at the bottom.
link *	removeHead ()
	Remove and return first entry.
link *	remove (link *item)
	Remove and return element.
link *	remove (iterator &iter)
	Remove and return element specified by iterator.
link *	replace (link *oldLink, link *newLink)
	Replace oldLink with newLink and return element.
link *	replace (iterator &oldIter, link *newitem)
	Replace oldIter with newItem and return element.
void	clear ()
	Clear the list.
void	swap (DLListBase &lst)
	Swap the contents of the list.
void	transfer (DLListBase &lst)
	Transfer the contents of the argument into this list and annul the argument list.
iterator	begin ()
	Iterator to first item in list with non-const access.
const_iterator	cbegin () const
	Iterator to first item in list with const access.
const_iterator	crbegin () const
	Iterator to last item in list with const access.
const iterator &	end ()
	End of list for iterators.
const const_iterator &	cend () const
	End of list for iterators.
const const_iterator &	crend () const
	End of list for reverse iterators.
link *	first ()
	Return first entry.
const link *	first () const
	Return const access to first entry.
link *	last ()
	Return last entry.
const link *	last () const
	Return const access to last entry.
void	prepend (link *item)
	Add at front of list.
void	append (link *item)
	Add at back of list.

Additional Inherited Members
Protected Member Functions inherited from DictionaryBase< IDLList< T >, T >
bool	addHashEntry (const word &key, T *ptr)
	Add an entry to the HashTable.
void	addEntries ()
	Add the IDLListType entries into the HashTable.
Protected Member Functions inherited from DLListBase
template<class IteratorType>
IteratorType	iterator_first () const
	Return iterator to first item or end-iterator if list is empty.
template<class IteratorType>
IteratorType	iterator_last () const
	Return iterator to last item or end-iterator if list is empty.
Static Protected Member Functions inherited from DLListBase
template<class IteratorType>
static const IteratorType &	iterator_end ()
	Factory method to return an iterator end.
template<class IteratorType>
static const IteratorType &	iterator_rend ()
	Factory method to return an iterator reverse end.
Protected Attributes inherited from DictionaryBase< IDLList< T >, T >
HashTable< T * >	hashedTs_
	HashTable of the entries held on the IDLListType for quick lookup.

Detailed Description

template<class T>
class Foam::Dictionary< T >

General purpose template dictionary class that manages the storage associated with it.

It is derived from DictionaryBase instantiated on a memory managed form of intrusive doubly-linked list of <T>.

Definition at line 48 of file Dictionary.H.

Member Typedef Documentation

dict_type

template<class T>

typedef DictionaryBase<IDLList<T>, T> dict_type

The template instance used for the dictionary content.

Definition at line 57 of file Dictionary.H.

Constructor & Destructor Documentation

Dictionary() [1/2]

template<class T>

Dictionary ( const label initialCapacity = 128 )

inlineexplicit

Default construct, or with initial table capacity.

Definition at line 65 of file Dictionary.H.

Referenced by Dictionary().

Here is the caller graph for this function:

Dictionary() [2/2]

template<class T>

Dictionary ( const Dictionary< T > & dict )

inline

Copy construct.

Definition at line 73 of file Dictionary.H.

References dict, and Dictionary().

Here is the call graph for this function:

Member Function Documentation

erase()

template<class T>

bool erase ( const word & keyword )

inline

Remove an entry specified by keyword and delete the pointer.

Returns

true if the keyword was found

Definition at line 86 of file Dictionary.H.

References DictionaryBase< IDLList< T >, T >::remove(), and Foam::T().

Here is the call graph for this function:

---

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

• src/OpenFOAM/containers/Dictionaries/Dictionary/Dictionary.H