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_base &	operator++ ()
key_iterator_base	operator++ (int)

Detailed Description

template<class T, class Key = word, class Hash = Foam::Hash<Key>>
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 876 of file HashTable.H.

Member Typedef Documentation

value_type

using value_type = this_type::key_type

Definition at line 882 of file HashTable.H.

pointer

using pointer = const Key*

Definition at line 883 of file HashTable.H.

reference

using reference = const Key&

Definition at line 884 of file HashTable.H.

Constructor & Destructor Documentation

key_iterator_base() [1/2]

constexpr key_iterator_base ( )

inlineconstexprnoexcept

Default construct (end iterator)

Definition at line 887 of file HashTable.H.

key_iterator_base() [2/2]

key_iterator_base ( const Iter &  iter )

inlineexplicit

Copy construct with implicit conversion.

Definition at line 893 of file HashTable.H.

Member Function Documentation

operator*()

reference operator* ( ) const

inline

Return the key.

Definition at line 899 of file HashTable.H.

operator()()

reference operator() ( ) const

inline

Definition at line 900 of file HashTable.H.

operator++() [1/2]

key_iterator_base & operator++ ( )

inline

Definition at line 902 of file HashTable.H.

operator++() [2/2]

key_iterator_base operator++ ( int  )

inline

Definition at line 908 of file HashTable.H.

---

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

• src/OpenFOAM/containers/HashTables/HashTable/HashTable.H