Hash map constant iterator. More...

#include <hashmap.h>

Public Types
typedef std::pair< TKey, TValue >	value_type

typedef value_type &	reference

typedef const value_type &	const_reference

typedef value_type *	pointer

typedef const value_type *	const_pointer

typedef ptrdiff_t	difference_type

typedef size_t	size_type

typedef std::bidirectional_iterator_tag	iterator_category

Public Member Functions
	HashMapConstIterator () noexcept

	HashMapConstIterator (const TContainer *container) noexcept

	HashMapConstIterator (const TContainer *container, size_t index) noexcept

	HashMapConstIterator (const HashMapIterator< TContainer, TKey, TValue > &it) noexcept

	HashMapConstIterator (const HashMapConstIterator &it) noexcept=default

	HashMapConstIterator (HashMapConstIterator &&it) noexcept=default

	~HashMapConstIterator () noexcept=default

HashMapConstIterator &	operator= (const HashMapIterator< TContainer, TKey, TValue > &it) noexcept

HashMapConstIterator &	operator= (const HashMapConstIterator &it) noexcept=default

HashMapConstIterator &	operator= (HashMapConstIterator &&it) noexcept=default

HashMapConstIterator &	operator++ () noexcept

HashMapConstIterator	operator++ (int) noexcept

const_reference	operator* () const noexcept

const_pointer	operator-> () const noexcept

	operator bool () const noexcept
	Check if the iterator is valid.

void	swap (HashMapConstIterator &it) noexcept
	Swap two instances.

Friends
bool	operator== (const HashMapConstIterator &it1, const HashMapConstIterator &it2) noexcept

bool	operator!= (const HashMapConstIterator &it1, const HashMapConstIterator &it2) noexcept

template<class UContainer , typename UKey , typename UValue >
void	swap (HashMapConstIterator< UContainer, UKey, UValue > &it1, HashMapConstIterator< UContainer, UKey, UValue > &it2) noexcept

Detailed Description

template<class TContainer, typename TKey, typename TValue>
class CppCommon::HashMapConstIterator< TContainer, TKey, TValue >

Hash map constant iterator.

Not thread-safe.

Definition at line 278 of file hashmap.h.

Member Typedef Documentation

◆ const_pointer

template<class TContainer , typename TKey , typename TValue >

typedef const value_type* CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::const_pointer

Definition at line 288 of file hashmap.h.

◆ const_reference

template<class TContainer , typename TKey , typename TValue >

typedef const value_type& CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::const_reference

Definition at line 286 of file hashmap.h.

◆ difference_type

template<class TContainer , typename TKey , typename TValue >

typedef ptrdiff_t CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::difference_type

Definition at line 289 of file hashmap.h.

◆ iterator_category

template<class TContainer , typename TKey , typename TValue >

typedef std::bidirectional_iterator_tag CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::iterator_category

Definition at line 291 of file hashmap.h.

◆ pointer

template<class TContainer , typename TKey , typename TValue >

typedef value_type* CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::pointer

Definition at line 287 of file hashmap.h.

◆ reference

template<class TContainer , typename TKey , typename TValue >

typedef value_type& CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::reference

Definition at line 285 of file hashmap.h.

◆ size_type

template<class TContainer , typename TKey , typename TValue >

typedef size_t CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::size_type

Definition at line 290 of file hashmap.h.

◆ value_type

template<class TContainer , typename TKey , typename TValue >

typedef std::pair<TKey, TValue> CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::value_type

Definition at line 284 of file hashmap.h.

Constructor & Destructor Documentation

◆ HashMapConstIterator() [1/6]

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::HashMapConstIterator ( )

inlinenoexcept

Definition at line 293 of file hashmap.h.

◆ HashMapConstIterator() [2/6]

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::HashMapConstIterator ( const TContainer * container )

inlineexplicitnoexcept

Definition at line 417 of file hashmap.inl.

◆ HashMapConstIterator() [3/6]

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::HashMapConstIterator	(	const TContainer *	container,
		size_t	index
	)

inlineexplicitnoexcept

Definition at line 295 of file hashmap.h.

◆ HashMapConstIterator() [4/6]

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::HashMapConstIterator ( const HashMapIterator< TContainer, TKey, TValue > & it )

inlinenoexcept

Definition at line 296 of file hashmap.h.

◆ HashMapConstIterator() [5/6]

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::HashMapConstIterator ( const HashMapConstIterator< TContainer, TKey, TValue > & it )

defaultnoexcept

◆ HashMapConstIterator() [6/6]

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::HashMapConstIterator ( HashMapConstIterator< TContainer, TKey, TValue > && it )

defaultnoexcept

◆ ~HashMapConstIterator()

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::~HashMapConstIterator ( )

defaultnoexcept

Member Function Documentation

◆ operator bool()

template<class TContainer , typename TKey , typename TValue >

CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator bool ( ) const

inlineexplicitnoexcept

Check if the iterator is valid.

Definition at line 318 of file hashmap.h.

◆ operator*()

template<class TContainer , typename TKey , typename TValue >

HashMapConstIterator< TContainer, TKey, TValue >::const_reference CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator* ( ) const

noexcept

Definition at line 475 of file hashmap.inl.

◆ operator++() [1/2]

template<class TContainer , typename TKey , typename TValue >

HashMapConstIterator< TContainer, TKey, TValue > & CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator++ ( )

noexcept

Definition at line 445 of file hashmap.inl.

◆ operator++() [2/2]

template<class TContainer , typename TKey , typename TValue >

HashMapConstIterator< TContainer, TKey, TValue > CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator++ ( int )

inlinenoexcept

Definition at line 467 of file hashmap.inl.

◆ operator->()

template<class TContainer , typename TKey , typename TValue >

HashMapConstIterator< TContainer, TKey, TValue >::const_pointer CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator-> ( ) const

noexcept

Definition at line 483 of file hashmap.inl.

◆ operator=() [1/3]

template<class TContainer , typename TKey , typename TValue >

HashMapConstIterator & CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator= ( const HashMapConstIterator< TContainer, TKey, TValue > & it )

defaultnoexcept

◆ operator=() [2/3]

template<class TContainer , typename TKey , typename TValue >

HashMapConstIterator & CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator= ( const HashMapIterator< TContainer, TKey, TValue > & it )

inlinenoexcept

Definition at line 301 of file hashmap.h.

◆ operator=() [3/3]

template<class TContainer , typename TKey , typename TValue >

HashMapConstIterator & CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::operator= ( HashMapConstIterator< TContainer, TKey, TValue > && it )

defaultnoexcept

◆ swap()

template<class TContainer , typename TKey , typename TValue >

void CppCommon::HashMapConstIterator< TContainer, TKey, TValue >::swap ( HashMapConstIterator< TContainer, TKey, TValue > & it )

noexcept

Swap two instances.

Definition at line 489 of file hashmap.inl.

Friends And Related Symbol Documentation

◆ operator!=

template<class TContainer , typename TKey , typename TValue >

bool operator!=	(	const HashMapConstIterator< TContainer, TKey, TValue > &	it1,
		const HashMapConstIterator< TContainer, TKey, TValue > &	it2
	)

friend

Definition at line 308 of file hashmap.h.

◆ operator==

template<class TContainer , typename TKey , typename TValue >

bool operator==	(	const HashMapConstIterator< TContainer, TKey, TValue > &	it1,
		const HashMapConstIterator< TContainer, TKey, TValue > &	it2
	)

friend

Definition at line 306 of file hashmap.h.

◆ swap

template<class TContainer , typename TKey , typename TValue >

template<class UContainer , typename UKey , typename UValue >

void swap	(	HashMapConstIterator< UContainer, UKey, UValue > &	it1,
		HashMapConstIterator< UContainer, UKey, UValue > &	it2
	)

friend

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

include/containers/hashmap.h
include/containers/hashmap.inl

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ const_pointer

◆ const_reference

◆ difference_type

◆ iterator_category

◆ pointer

◆ reference

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ HashMapConstIterator() [1/6]

◆ HashMapConstIterator() [2/6]

◆ HashMapConstIterator() [3/6]

◆ HashMapConstIterator() [4/6]

◆ HashMapConstIterator() [5/6]

◆ HashMapConstIterator() [6/6]

◆ ~HashMapConstIterator()

Member Function Documentation

◆ operator bool()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator->()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ swap()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator==

◆ swap