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

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

#include <HashTable.H>

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).
	key_iterator_base (const Iter &iter)
	Copy construct with implicit conversion.
reference	operator* () const
	Return the key.
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 1235 of file HashTable.H.

Member Typedef Documentation

value_type

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

using value_type = this_type::key_type

Definition at line 1241 of file HashTable.H.

pointer

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

using pointer = const Key*

Definition at line 1242 of file HashTable.H.

reference

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

using reference = const Key&

Definition at line 1243 of file HashTable.H.

Constructor & Destructor Documentation

key_iterator_base() [1/2]

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

key_iterator_base ( )

inlineconstexprnoexcept

Default construct (end iterator).

Definition at line 1248 of file HashTable.H.

key_iterator_base() [2/2]

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

key_iterator_base ( const Iter & iter )

inlineexplicit

Copy construct with implicit conversion.

Definition at line 1256 of file HashTable.H.

Member Function Documentation

operator*()

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

reference operator* ( ) const

inline

Return the key.

Definition at line 1264 of file HashTable.H.

operator()()

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

reference operator() ( ) const

inline

Definition at line 1265 of file HashTable.H.

operator++() [1/2]

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

key_iterator_base & operator++ ( )

inline

Definition at line 1267 of file HashTable.H.

operator++() [2/2]

template<class T, class Key = word, class Hash = Foam::Hash<Key>>

template<class Iter>

key_iterator_base operator++ ( int )

inline

Definition at line 1273 of file HashTable.H.

---

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

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