HashTable< T, Key, Hash >::key_iterator_base< Iter > Class Template Reference

An iterator wrapper for returning a reference to the key. More...

Inheritance diagram for HashTable< T, Key, Hash >::key_iterator_base< Iter >:
Collaboration diagram for HashTable< T, Key, Hash >::key_iterator_base< Iter >:

Public Types

using value_type = this_type::key_type
using pointer = const Key *
using reference = const Key &

Public Member Functions

constexpr key_iterator_base () noexcept
 Default construct (end iterator) More...
 key_iterator_base (const Iter &iter)
 Copy construct with implicit conversion. More...
reference operator* () const
 Return the key. More...
reference operator() () const
key_iterator_baseoperator++ ()
key_iterator_base operator++ (int)

Detailed Description

template<class T, class Key = word, class Hash = string::hash>
template<class Iter>
class Foam::HashTable< T, Key, Hash >::key_iterator_base< Iter >

An iterator wrapper for returning a reference to the key.

Definition at line 820 of file HashTable.H.

Member Typedef Documentation

◆ value_type

Definition at line 826 of file HashTable.H.

◆ pointer

using pointer = const Key*

Definition at line 827 of file HashTable.H.

◆ reference

using reference = const Key&

Definition at line 828 of file HashTable.H.

Constructor & Destructor Documentation

◆ key_iterator_base() [1/2]

constexpr key_iterator_base ( )

Default construct (end iterator)

Definition at line 831 of file HashTable.H.

◆ key_iterator_base() [2/2]

key_iterator_base ( const Iter &  iter)

Copy construct with implicit conversion.

Definition at line 837 of file HashTable.H.

Member Function Documentation

◆ operator*()

reference operator* ( ) const

Return the key.

Definition at line 843 of file HashTable.H.

◆ operator()()

reference operator() ( ) const

Definition at line 844 of file HashTable.H.

◆ operator++() [1/2]

key_iterator_base& operator++ ( )

Definition at line 846 of file HashTable.H.

◆ operator++() [2/2]

key_iterator_base operator++ ( int  )

Definition at line 852 of file HashTable.H.

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