UPtrDictionary< T > Class Template Reference

Template dictionary class which does not manages the storage associated with it. More...

Inheritance diagram for UPtrDictionary< T >:
[legend]
Collaboration diagram for UPtrDictionary< T >:
[legend]

Public Member Functions

 UPtrDictionary (const label size=128)
 Construct given initial table size. More...
 
 UPtrDictionary (const UPtrDictionary &dict)
 Copy construct. More...
 
- Public Member Functions inherited from DictionaryBase< DLList< 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 Tcfind (const word &keyword) const
 Find and return an entry, nullptr on failure. More...
 
Tfind (const word &keyword)
 Find and return an entry, nullptr on failure. More...
 
const Tlookup (const word &keyword) const
 Find and return entry, FatalError on failure. More...
 
Tlookup (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...
 
Tremove (const word &keyword)
 Remove and return entry specified by keyword. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (DictionaryBase< DLList< T * >, T > &dict)
 Transfer the contents of the argument into this DictionaryBase. More...
 
void operator= (const DictionaryBase &)
 Copy assignment. More...
 
const Toperator[] (const word &key) const
 Find and return entry. More...
 
Toperator[] (const word &key)
 Find and return entry. More...
 
const TlookupPtr (const word &keyword) const
 Deprecated(2020-03) use cfind() More...
 
TlookupPtr (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 LList< LListBase, T >
 LList ()=default
 Default construct. More...
 
 LList (const T &elem)
 Construct and copy add initial item. More...
 
 LList (T &&elem)
 Construct and move add initial item. More...
 
 LList (Istream &is)
 Construct from Istream. More...
 
 LList (const LList< LListBase, T > &lst)
 Copy construct. More...
 
 LList (LList< LListBase, T > &&lst)
 Move construct. More...
 
 LList (std::initializer_list< T > lst)
 Copy construct from an initializer list. More...
 
 ~LList ()
 Destructor. More...
 
reference first ()
 The first entry in the list. More...
 
const_reference first () const
 The first entry in the list (const access) More...
 
reference last ()
 The last entry in the list. More...
 
const_reference last () const
 The last entry in the list (const access) More...
 
void prepend (const T &elem)
 Add copy at front of list. More...
 
void prepend (T &&elem)
 Move construct at front of list. More...
 
void append (const T &elem)
 Add copy at back of list. More...
 
void append (T &&elem)
 Move construct at back of list. More...
 
bool eraseHead ()
 Erase the first entry. More...
 
T removeHead ()
 Remove and return first entry. More...
 
T remove (link *item)
 Remove and return element. More...
 
T remove (iterator &iter)
 Remove and return element specified by iterator. More...
 
void clear ()
 Delete contents of list. More...
 
void transfer (LList< LListBase, T > &lst)
 
void operator= (const LList< LListBase, T > &lst)
 Copy assignment. More...
 
void operator= (LList< LListBase, T > &&lst)
 Move assignment. More...
 
void operator= (std::initializer_list< T > lst)
 Copy assignment from an initializer list. More...
 
IstreamreadList (Istream &is)
 Read list from Istream. More...
 
OstreamwriteList (Ostream &os, const label shortLen=0) const
 Write LList 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 iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. More...
 
void insert (const T &elem)
 Add copy at front of list. Same as prepend() More...
 
void insert (T &&elem)
 Move construct at front of list. Same as prepend() More...
 

Additional Inherited Members

- Public Types inherited from LList< LListBase, T >
typedef T value_type
 Type of values stored. More...
 
typedef Tpointer
 Pointer for value_type. More...
 
typedef const Tconst_pointer
 Const pointer for value_type. More...
 
typedef Treference
 Reference for value_type. More...
 
typedef const Tconst_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 iterators. More...
 
using base_iterator = typename LListBase::iterator
 
using const_base_iterator = typename LListBase::const_iterator
 
- Protected Member Functions inherited from DictionaryBase< DLList< T * >, T >
void addEntries ()
 
- Protected Attributes inherited from DictionaryBase< DLList< T * >, T >
HashTable< T * > hashedTs_
 HashTable of the entries held on the IDLListType for quick lookup. More...
 

Detailed Description

template<class T>
class Foam::UPtrDictionary< T >

Template dictionary class which does not manages the storage associated with it.

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

Definition at line 53 of file UPtrDictionary.H.

Constructor & Destructor Documentation

◆ UPtrDictionary() [1/2]

UPtrDictionary ( const label  size = 128)
inlineexplicit

Construct given initial table size.

Definition at line 62 of file UPtrDictionary.H.

◆ UPtrDictionary() [2/2]

UPtrDictionary ( const UPtrDictionary< T > &  dict)
inline

Copy construct.

Definition at line 68 of file UPtrDictionary.H.


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