nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator Class Reference

Const iterator for OrderedHashMap that follows insertion order. More...

#include <nfx/containers/OrderedHashMap.h>

Public Types
using	iterator_category = std::bidirectional_iterator_tag
	STL iterator category (bidirectional iterator).
using	value_type = std::pair<const TKey, TValue>
	STL iterator value type (const key-value pair).
using	difference_type = std::ptrdiff_t
	STL iterator difference type.
using	pointer = const value_type*
	STL iterator pointer type.
using	reference = const value_type&
	STL iterator reference type.

Public Member Functions
	ConstIterator ()=default
	Default constructor creates an invalid iterator.
	ConstIterator (const Node *node)
	Construct const iterator from node.
	ConstIterator (const Iterator &it)
	Convert from non-const iterator.
reference	operator* () const
	Dereference operator to access key-value pair.
pointer	operator-> () const
	Arrow operator to access key-value pair members.
ConstIterator &	operator++ ()
	Pre-increment operator to advance to next element in insertion order.
ConstIterator	operator++ (int)
	Post-increment operator to advance to next element in insertion order.
ConstIterator &	operator-- ()
	Pre-decrement operator to move to previous element in insertion order.
ConstIterator	operator-- (int)
	Post-decrement operator to move to previous element in insertion order.
bool	operator== (const ConstIterator &other) const
	Equality comparison operator.
bool	operator!= (const ConstIterator &other) const
	Inequality comparison operator.

Friends
class	OrderedHashMap

Detailed Description

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>
class nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator

Const iterator for OrderedHashMap that follows insertion order.

Definition at line 797 of file OrderedHashMap.h.

Member Typedef Documentation

difference_type

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

using nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::difference_type = std::ptrdiff_t

STL iterator difference type.

Definition at line 809 of file OrderedHashMap.h.

iterator_category

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

using nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::iterator_category = std::bidirectional_iterator_tag

STL iterator category (bidirectional iterator).

Definition at line 803 of file OrderedHashMap.h.

pointer

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

using nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::pointer = const value_type*

STL iterator pointer type.

Definition at line 812 of file OrderedHashMap.h.

reference

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

using nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::reference = const value_type&

STL iterator reference type.

Definition at line 815 of file OrderedHashMap.h.

value_type

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

using nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::value_type = std::pair<const TKey, TValue>

STL iterator value type (const key-value pair).

Definition at line 806 of file OrderedHashMap.h.

Constructor & Destructor Documentation

ConstIterator() [1/2]

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::ConstIterator ( const Node * node )

inlineexplicit

Construct const iterator from node.

Parameters

node	Node pointer (nullptr for end iterator)

ConstIterator() [2/2]

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::ConstIterator ( const Iterator & it )

inline

Convert from non-const iterator.

Parameters

it	Non-const iterator to convert from

Member Function Documentation

operator!=()

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

bool nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator!= ( const ConstIterator & other ) const

inline

Inequality comparison operator.

Parameters

other

Iterator to compare with

Returns

true if iterators point to different nodes

operator*()

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

reference nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator* ( ) const

inline

Dereference operator to access key-value pair.

Returns

Const reference to current key-value pair

operator++() [1/2]

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

ConstIterator & nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator++ ( )

inline

Pre-increment operator to advance to next element in insertion order.

Returns

Reference to this iterator after advancement

operator++() [2/2]

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

ConstIterator nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator++ ( int )

inline

Post-increment operator to advance to next element in insertion order.

Returns

Copy of iterator before advancement

operator--() [1/2]

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

ConstIterator & nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator-- ( )

inline

Pre-decrement operator to move to previous element in insertion order.

Returns

Reference to this iterator after moving backward

operator--() [2/2]

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

ConstIterator nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator-- ( int )

inline

Post-decrement operator to move to previous element in insertion order.

Returns

Copy of iterator before moving backward

operator->()

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

pointer nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator-> ( ) const

inline

Arrow operator to access key-value pair members.

Returns

Const pointer to current key-value pair

operator==()

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

bool nfx::containers::OrderedHashMap< TKey, TValue, HashType, Seed, THasher, KeyEqual >::ConstIterator::operator== ( const ConstIterator & other ) const

inline

Equality comparison operator.

Parameters

other

Iterator to compare with

Returns

true if iterators point to the same node

Friends And Related Symbol Documentation

OrderedHashMap

template<typename TKey, typename TValue, hashing::Hash32or64 HashType = uint32_t, HashType Seed = ( sizeof( HashType ) == 4 ? hashing::constants::FNV_OFFSET_BASIS_32 : hashing::constants::FNV_OFFSET_BASIS_64 ), typename THasher = hashing::Hasher<HashType, Seed>, typename KeyEqual = std::equal_to<>>

friend class OrderedHashMap

friend

Definition at line 799 of file OrderedHashMap.h.

---

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

• OrderedHashMap.h