General purpose template dictionary class that manages the storage associated with it. More...
Public Member Functions | |
| Dictionary (const label size=128) | |
| Construct with given or default (128) table capacity. More... | |
| Dictionary (const Dictionary &dict) | |
| Copy construct. 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 with given or default (128) table capacity. More... | |
| DictionaryBase (const DictionaryBase &dict) | |
| Copy construct. More... | |
| DictionaryBase (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. More... | |
| DictionaryBase (Istream &is) | |
| Construct from Istream using default Istream constructor class. More... | |
| bool | found (const word &keyword) const |
| Search for given keyword. More... | |
| const T * | cfind (const word &keyword) const |
| Find and return an entry, nullptr on failure. More... | |
| T * | find (const word &keyword) |
| Find and return an entry, nullptr on failure. More... | |
| const T * | lookup (const word &keyword) const |
| Find and return entry, FatalError on failure. More... | |
| T * | lookup (const word &keyword) |
| Find and return entry, FatalError on failure. More... | |
| wordList | toc () const |
| Return the table of contents (as a sorted list) More... | |
| wordList | sortedToc () const |
| Return the table of contents as a sorted list. More... | |
| wordList | sortedToc (const Compare &comp) const |
| Return table of contents sorted using the specified comparator. More... | |
| Foam::wordList | sortedToc (const Compare &comp) const |
| void | prepend (const word &keyword, T *ptr) |
| Add to front of dictionary. More... | |
| void | append (const word &keyword, T *ptr) |
| Add to back of dictionary. More... | |
| T * | remove (const word &keyword) |
| Remove and return entry specified by keyword. More... | |
| void | clear () |
| Clear the dictionary. More... | |
| void | transfer (DictionaryBase< IDLList< T >, T > &dict) |
| Transfer the contents of the argument into this DictionaryBase. More... | |
| void | operator= (const DictionaryBase &) |
| Copy assignment. More... | |
| const T * | operator[] (const word &key) const |
| Find and return entry. More... | |
| T * | operator[] (const word &key) |
| Find and return entry. More... | |
| const T * | lookupPtr (const word &keyword) const |
| Deprecated(2020-03) use cfind() More... | |
| T * | lookupPtr (const word &keyword) |
| Deprecated(2020-03) use find() More... | |
| void | insert (const word &keyword, T *ptr) |
| Add to front of dictionary. More... | |
| Public Member Functions inherited from ILList< LListBase, T > | |
| ILList ()=default | |
| Default construct. More... | |
| ILList (T *item) | |
| Construct and add initial item pointer. More... | |
| ILList (Istream &is) | |
| Construct from Istream. More... | |
| ILList (const ILList< LListBase, T > &lst) | |
| Copy construct using the 'clone()' method for each element. More... | |
| ILList (ILList< LListBase, T > &&lst) | |
| Move construct. More... | |
| template<class CloneArg > | |
| ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone 'clone()'. More... | |
| template<class INew > | |
| ILList (Istream &is, const INew &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 *item) |
| 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 > &lst) |
| void | operator= (const ILList< LListBase, T > &lst) |
| Copy assignment using the 'clone()' method for each element. More... | |
| void | operator= (ILList< LListBase, T > &&lst) |
| Move assignment. More... | |
| Public Member Functions inherited from UILList< LListBase, T > | |
| UILList ()=default | |
| Default construct. More... | |
| UILList (T *item) | |
| Construct and add initial item pointer. More... | |
| UILList (const UILList< LListBase, T > &lst) | |
| Construct as copy. More... | |
| T * | first () |
| The first entry in the list. More... | |
| const T * | first () const |
| The first entry in the list (const access) More... | |
| T * | last () |
| The last entry in the list. More... | |
| const T * | last () const |
| The last entry in the list (const access) More... | |
| T * | removeHead () |
| Remove and return head. More... | |
| T * | remove (T *item) |
| Remove and return element. More... | |
| T * | remove (iterator &iter) |
| Remove and return item specified by iterator. More... | |
| void | operator= (const UILList< LListBase, T > &lst) |
| Copy assignment. More... | |
| bool | operator== (const UILList< LListBase, T > &lst) const |
| Equality. True both lists are element-wise equal. More... | |
| bool | operator!= (const UILList< LListBase, T > &lst) const |
| The opposite of the equality operation. Takes linear time. More... | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write UILList with line-breaks when length exceeds shortLen. More... | |
| iterator | begin () |
| Iterator to first item in list with non-const access. More... | |
| const_iterator | cbegin () const |
| Iterator to first item in list with const access. More... | |
| reverse_iterator | rbegin () |
| Iterator to last item in list with non-const access. More... | |
| const_reverse_iterator | crbegin () const |
| Iterator to last item in list with const access. More... | |
| const_iterator | begin () const |
| Iterator to first item in list with const access. More... | |
| const_reverse_iterator | rbegin () const |
| Iterator to last item in list with const access. More... | |
| const iterator & | end () |
| End of list for forward iterators. More... | |
| const const_iterator & | cend () const |
| End of list for forward iterators. More... | |
| const reverse_iterator & | rend () |
| End of list for reverse iterators. More... | |
| const const_reverse_iterator & | crend () const |
| End of list for reverse iterators. More... | |
| const const_iterator & | end () const |
| End of list for forward iterators. More... | |
| const const_reverse_iterator & | rend () const |
| End of list for reverse iterators. More... | |
Additional Inherited Members | |
| Public Types inherited from UILList< LListBase, T > | |
| typedef T | value_type |
| Type of values stored. More... | |
| typedef T * | pointer |
| Pointer for value_type. More... | |
| typedef const T * | const_pointer |
| Const pointer for value_type. More... | |
| typedef T & | reference |
| Reference for value_type. More... | |
| typedef const T & | const_reference |
| Const reference for value_type. More... | |
| typedef label | size_type |
| The type that can represent the container size. More... | |
| typedef label | difference_type |
| The difference between iterator objects. More... | |
| using | base_iterator = typename LListBase::iterator |
| using | const_base_iterator = typename 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... | |
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 57 of file Dictionary.H.
|
explicit |
Construct with given or default (128) table capacity.
Definition at line 34 of file Dictionary.C.
| Dictionary | ( | const Dictionary< T > & | dict | ) |
Copy construct.
Definition at line 41 of file Dictionary.C.
Remove an entry specified by keyword and delete the pointer.
Definition at line 50 of file Dictionary.C.
References T.
1.9.5 