StormByte::Iterable< Container >::Iterator Class Reference

Wrapper iterator for Iterable. More...

#include <iterable.hxx>

Public Types
using	iterator_category = std::random_access_iterator_tag
using	value_type = typename Container::value_type
using	difference_type = typename Container::difference_type
using	pointer = typename Container::pointer
using	reference = typename Container::reference

Public Member Functions
reference	operator* ()
	Dereference operator.
pointer	operator-> ()
	Arrow operator.
Iterator &	operator++ ()
	Pre-increment operator.
Iterator	operator++ (int)
	Post-increment operator.
Iterator &	operator-- ()
	Pre-decrement operator.
Iterator	operator-- (int)
	Post-decrement operator.
Iterator &	operator+= (difference_type n)
	Compound addition operator.
Iterator &	operator-= (difference_type n)
	Compound subtraction operator.
Iterator	operator+ (difference_type n) const
	Addition operator.
Iterator	operator- (difference_type n) const
	Subtraction operator.
difference_type	operator- (const Iterator &other) const
	Subtraction operator between two iterators.
bool	operator== (const Iterator &other) const
	Subscript operator.
bool	operator!= (const Iterator &other) const
	Inequality operator.

Friends
class	Iterable

Detailed Description

template<typename Container>
class StormByte::Iterable< Container >::Iterator

Wrapper iterator for Iterable.

Member Function Documentation

operator!=()

template<typename Container >

bool StormByte::Iterable< Container >::Iterator::operator!= ( const Iterator &  other ) const

inline

Inequality operator.

Parameters

other

The other iterator to compare

Returns

True if the iterators are not equal, false otherwise

operator*()

template<typename Container >

reference StormByte::Iterable< Container >::Iterator::operator* ( )

inline

Dereference operator.

Returns

Reference to the current element

operator+()

template<typename Container >

Iterator StormByte::Iterable< Container >::Iterator::operator+ ( difference_type  n ) const

inline

Addition operator.

Parameters

n	Number of positions to advance

Returns

New iterator advanced by n positions

operator++() [1/2]

template<typename Container >

Iterator & StormByte::Iterable< Container >::Iterator::operator++ ( )

inline

Pre-increment operator.

Returns

Reference to the incremented iterator

operator++() [2/2]

template<typename Container >

Iterator StormByte::Iterable< Container >::Iterator::operator++ ( int  )

inline

Post-increment operator.

Returns

Iterator before increment

operator+=()

template<typename Container >

Iterator & StormByte::Iterable< Container >::Iterator::operator+= ( difference_type  n )

inline

Compound addition operator.

Parameters

n	Number of positions to advance

Returns

Reference to the advanced iterator

operator-() [1/2]

template<typename Container >

difference_type StormByte::Iterable< Container >::Iterator::operator- ( const Iterator &  other ) const

inline

Subtraction operator between two iterators.

Parameters

other

The other iterator to subtract

Returns

Difference in positions between the two iterators

operator-() [2/2]

template<typename Container >

Iterator StormByte::Iterable< Container >::Iterator::operator- ( difference_type  n ) const

inline

Subtraction operator.

Parameters

n	Number of positions to retreat

Returns

New iterator retreated by n positions

operator--() [1/2]

template<typename Container >

Iterator & StormByte::Iterable< Container >::Iterator::operator-- ( )

inline

Pre-decrement operator.

Returns

Reference to the decremented iterator

operator--() [2/2]

template<typename Container >

Iterator StormByte::Iterable< Container >::Iterator::operator-- ( int  )

inline

Post-decrement operator.

Returns

Iterator before decrement

operator-=()

template<typename Container >

Iterator & StormByte::Iterable< Container >::Iterator::operator-= ( difference_type  n )

inline

Compound subtraction operator.

Parameters

n	Number of positions to retreat

Returns

Reference to the retreated iterator

operator->()

template<typename Container >

pointer StormByte::Iterable< Container >::Iterator::operator-> ( )

inline

Arrow operator.

Returns

Pointer to the current element

operator==()

template<typename Container >

bool StormByte::Iterable< Container >::Iterator::operator== ( const Iterator &  other ) const

inline

Subscript operator.

Parameters

n	Index to access

Returns

Reference to the element at index n

---

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

• /home/runner/work/StormByte/StormByte/lib/public/StormByte/iterable.hxx