Dictionary< T > Class Template Reference

Gerneral purpose template dictionary class which manages the storage associated with it. More...

Inheritance diagram for Dictionary< T >:
Collaboration diagram for Dictionary< T >:

Public Member Functions

 Dictionary (const label size=128)
 Construct given initial table size. More...
 
 Dictionary (const Dictionary &)
 Copy constructor. More...
 
 Dictionary (Dictionary &&)
 Move constructor. More...
 
bool erase (const word &keyword)
 Remove an entry specified by keyword and delete the pointer. More...
 
- Public Member Functions inherited from DictionaryBase< IDLList< T >, T >
 DictionaryBase (const label size=128)
 Construct given initial table size. More...
 
 DictionaryBase (const DictionaryBase &)
 Copy constructor. More...
 
 DictionaryBase (DictionaryBase &&)
 Move constructor. More...
 
 DictionaryBase (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 DictionaryBase (Istream &)
 Construct from Istream using default Istream constructor class. More...
 
bool found (const word &) const
 Search DictionaryBase for given keyword. More...
 
const T * lookupPtr (const word &) const
 Find and return an entry if present, otherwise return nullptr. More...
 
T * lookupPtr (const word &)
 Find and return an entry if present, otherwise return nullptr. More...
 
const T * lookup (const word &) const
 Find and return entry. More...
 
T * lookup (const word &)
 Find and return entry. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the table of contents as a sorted list. More...
 
void insert (const word &, T *)
 Add at head of dictionary. More...
 
void append (const word &, T *)
 Add at tail of dictionary. More...
 
T * remove (const word &)
 Remove and return entry specified by keyword. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (DictionaryBase< IDLList< T >, T > &)
 Transfer the contents of the argument into this DictionaryBase. More...
 
void operator= (const DictionaryBase &)
 
const T * operator[] (const word &key) const
 Find and return entry. More...
 
T * operator[] (const word &key)
 Find and return entry. More...
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()
 Null construct. More...
 
 ILList (T *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &)
 Copy constructor. More...
 
 ILList (ILList< LListBase, T > &&)
 Move constructor. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
template<class INew >
 ILList (Istream &, const INew &)
 Construct from Istream using given Istream constructor class. More...
 
 ~ILList ()
 Destructor. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (ILList< LListBase, T > &&)
 Move assignment operator. More...
 
- Public Member Functions inherited from UILList< LListBase, T >
 UILList ()
 Null construct. More...
 
 UILList (T *a)
 Construct given initial T. More...
 
 UILList (const UILList< LListBase, T > &)
 Copy constructor. More...
 
 UILList (UILList< LListBase, T > &&)
 Move constructor. More...
 
T * first ()
 Return the first entry. More...
 
const T * first () const
 Return the first entry. More...
 
T * last ()
 Return the last entry. More...
 
const T * last () const
 Return the last entry. More...
 
T * removeHead ()
 Remove and return head. More...
 
T * remove (T *p)
 Remove and return element. More...
 
T * remove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< LListBase, T > &)
 Assignment operator. More...
 
void operator= (UILList< LListBase, T > &&)
 Move assignment operator. More...
 
iterator begin ()
 
const iterator & end ()
 
const_iterator cbegin () const
 
const const_iterator & cend () const
 
const_iterator begin () const
 
const const_iterator & end () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iterator & crend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iterator & rend () const
 
bool operator== (const UILList< LListBase, T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< LListBase, T > &) const
 The opposite of the equality operation. Takes linear time. More...
 

Additional Inherited Members

- Public Types inherited from UILList< LListBase, T >
typedef T value_type
 Type of values the DLList contains. More...
 
typedef T & reference
 Type that can be used for storing into DLList::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 DLList. More...
 
typedef LListBase::iterator LListBase_iterator
 
typedef LListBase::const_iterator LListBase_const_iterator
 
- Protected Member Functions inherited from DictionaryBase< IDLList< T >, T >
void addEntries ()
 
- Protected Attributes inherited from DictionaryBase< IDLList< T >, T >
HashTable< T *> hashedTs_
 HashTable of the entries held on the IDLListType for quick lookup. More...
 

Detailed Description

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

Gerneral purpose template dictionary class which manages the storage associated with it.

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

Source files

Definition at line 54 of file Dictionary.H.

Constructor & Destructor Documentation

◆ Dictionary() [1/3]

Dictionary ( const label  size = 128)

Construct given initial table size.

Definition at line 31 of file Dictionary.C.

◆ Dictionary() [2/3]

Dictionary ( const Dictionary< T > &  dict)

Copy constructor.

Definition at line 38 of file Dictionary.C.

◆ Dictionary() [3/3]

Dictionary ( Dictionary< T > &&  dict)

Move constructor.

Definition at line 45 of file Dictionary.C.

Member Function Documentation

◆ erase()

bool erase ( const word &  keyword)

Remove an entry specified by keyword and delete the pointer.

Returns true if the keyword was found

Definition at line 54 of file Dictionary.C.

References Foam::T().

Here is the call graph for this function:

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