CeresEngine::EnumerateIterator< Iterator, Index > Class Template Reference

An iterator type that keeps an index count of the current item. More...

#include <CeresEngine/Foundation/Iterator/Enumerate.hpp>

Public Types
using	iterator_category = typename std::iterator_traits< Iterator >::iterator_category
using	value_type = typename std::iterator_traits< Iterator >::value_type
using	difference_type = typename std::iterator_traits< Iterator >::difference_type
using	pointer = typename std::iterator_traits< Iterator >::pointer
using	reference = typename std::iterator_traits< Iterator >::reference

Public Member Functions
	EnumerateIterator (Index index, Iterator &&iterator)
	Creates a new enumerate iterator at the given index positioned at the given it iterator.
EnumerateIterator &	operator++ ()
	Increments the iterator. Will also increment the index position.
EnumerateIterator	operator++ (int)
	Increments the iterator. Will also increment the index position.
EnumerateIterator &	operator+ (difference_type offset)
	Advances the iterator by the given offset.
EnumerateIterator &	operator-- ()
	Decrements the iterator. Will also decrement the index position.
EnumerateIterator	operator-- (int)
	Decrements the iterator. Will also decrement the index position.
EnumerateIterator &	operator- (difference_type offset)
	Recedes the iterator by the given offset.
auto	operator* () const noexcept
	Dereferences the iterator and obtain it's value.
auto *	operator-> () const noexcept
	Dereferences the iterator and obtain it's value.
bool	operator== (const EnumerateIterator &other) const
bool	operator!= (const EnumerateIterator &other) const
bool	operator> (const EnumerateIterator &other) const
bool	operator>= (const EnumerateIterator &other) const
bool	operator< (const EnumerateIterator &other) const
bool	operator<= (const EnumerateIterator &other) const

Private Attributes
Index	mIndex = 0
	The current iteration index.
Iterator	mIterator
	The current iterator position.

Detailed Description

template<typename Iterator, typename Index = std::size_t>
class CeresEngine::EnumerateIterator< Iterator, Index >

An iterator type that keeps an index count of the current item.

Useful when you need both the value and the index of the value when doing for-range loop.

Template Parameters

Iterator	The underlying iterator type.
Index	The type of the counter index.

Member Typedef Documentation

difference_type

template<typename Iterator , typename Index = std::size_t>

using CeresEngine::EnumerateIterator< Iterator, Index >::difference_type = typename std::iterator_traits<Iterator>::difference_type

iterator_category

template<typename Iterator , typename Index = std::size_t>

using CeresEngine::EnumerateIterator< Iterator, Index >::iterator_category = typename std::iterator_traits<Iterator>::iterator_category

pointer

template<typename Iterator , typename Index = std::size_t>

using CeresEngine::EnumerateIterator< Iterator, Index >::pointer = typename std::iterator_traits<Iterator>::pointer

reference

template<typename Iterator , typename Index = std::size_t>

using CeresEngine::EnumerateIterator< Iterator, Index >::reference = typename std::iterator_traits<Iterator>::reference

value_type

template<typename Iterator , typename Index = std::size_t>

using CeresEngine::EnumerateIterator< Iterator, Index >::value_type = typename std::iterator_traits<Iterator>::value_type

Constructor & Destructor Documentation

EnumerateIterator()

template<typename Iterator , typename Index = std::size_t>

CeresEngine::EnumerateIterator< Iterator, Index >::EnumerateIterator ( Index  index, Iterator &&  iterator  )

inline

Creates a new enumerate iterator at the given index positioned at the given it iterator.

Member Function Documentation

operator!=()

template<typename Iterator , typename Index = std::size_t>

bool CeresEngine::EnumerateIterator< Iterator, Index >::operator!= ( const EnumerateIterator< Iterator, Index > &  other ) const

inline

operator*()

template<typename Iterator , typename Index = std::size_t>

auto CeresEngine::EnumerateIterator< Iterator, Index >::operator* ( ) const

inlinenoexcept

Dereferences the iterator and obtain it's value.

operator+()

template<typename Iterator , typename Index = std::size_t>

EnumerateIterator & CeresEngine::EnumerateIterator< Iterator, Index >::operator+ ( difference_type  offset )

inline

Advances the iterator by the given offset.

operator++() [1/2]

template<typename Iterator , typename Index = std::size_t>

EnumerateIterator & CeresEngine::EnumerateIterator< Iterator, Index >::operator++ ( )

inline

Increments the iterator. Will also increment the index position.

operator++() [2/2]

template<typename Iterator , typename Index = std::size_t>

EnumerateIterator CeresEngine::EnumerateIterator< Iterator, Index >::operator++ ( int  )

inline

Increments the iterator. Will also increment the index position.

operator-()

template<typename Iterator , typename Index = std::size_t>

EnumerateIterator & CeresEngine::EnumerateIterator< Iterator, Index >::operator- ( difference_type  offset )

inline

Recedes the iterator by the given offset.

operator--() [1/2]

template<typename Iterator , typename Index = std::size_t>

EnumerateIterator & CeresEngine::EnumerateIterator< Iterator, Index >::operator-- ( )

inline

Decrements the iterator. Will also decrement the index position.

operator--() [2/2]

template<typename Iterator , typename Index = std::size_t>

EnumerateIterator CeresEngine::EnumerateIterator< Iterator, Index >::operator-- ( int  )

inline

Decrements the iterator. Will also decrement the index position.

operator->()

template<typename Iterator , typename Index = std::size_t>

auto * CeresEngine::EnumerateIterator< Iterator, Index >::operator-> ( ) const

inlinenoexcept

Dereferences the iterator and obtain it's value.

operator<()

template<typename Iterator , typename Index = std::size_t>

bool CeresEngine::EnumerateIterator< Iterator, Index >::operator< ( const EnumerateIterator< Iterator, Index > &  other ) const

inline

operator<=()

template<typename Iterator , typename Index = std::size_t>

bool CeresEngine::EnumerateIterator< Iterator, Index >::operator<= ( const EnumerateIterator< Iterator, Index > &  other ) const

inline

operator==()

template<typename Iterator , typename Index = std::size_t>

bool CeresEngine::EnumerateIterator< Iterator, Index >::operator== ( const EnumerateIterator< Iterator, Index > &  other ) const

inline

operator>()

template<typename Iterator , typename Index = std::size_t>

bool CeresEngine::EnumerateIterator< Iterator, Index >::operator> ( const EnumerateIterator< Iterator, Index > &  other ) const

inline

operator>=()

template<typename Iterator , typename Index = std::size_t>

bool CeresEngine::EnumerateIterator< Iterator, Index >::operator>= ( const EnumerateIterator< Iterator, Index > &  other ) const

inline

Member Data Documentation

mIndex

template<typename Iterator , typename Index = std::size_t>

Index CeresEngine::EnumerateIterator< Iterator, Index >::mIndex = 0

private

The current iteration index.

mIterator

template<typename Iterator , typename Index = std::size_t>

Iterator CeresEngine::EnumerateIterator< Iterator, Index >::mIterator

private

The current iterator position.

---

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

• /Users/Rogiel/Developer/CeresEngine/Engine/Sources/CeresEngine/Foundation/Iterator/Enumerate.hpp