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

Const iterator adapter over Container::const_iterator. More...

#include <StormByte/iterable.hxx>

Public Types
using	iterator_category = typename std::iterator_traits< typename Container::const_iterator >::iterator_category
	Matches the underlying container iterator; not assumed random-access.
using	value_type = typename std::iterator_traits< typename Container::const_iterator >::value_type
using	difference_type = typename std::iterator_traits< typename Container::const_iterator >::difference_type
using	pointer = typename std::iterator_traits< typename Container::const_iterator >::pointer
using	reference = typename std::iterator_traits< typename Container::const_iterator >::reference

Public Member Functions
reference	operator* () const
	Dereference.
pointer	operator-> () const
	Member access.
ConstIterator &	operator++ ()
	Pre-increment.
ConstIterator	operator++ (int)
	Post-increment.
ConstIterator &	operator-- ()
	Pre-decrement.
ConstIterator	operator-- (int)
	Post-decrement.
ConstIterator &	operator+= (difference_type n)
	Advance in place.
ConstIterator &	operator-= (difference_type n)
	Retreat in place.
ConstIterator	operator+ (difference_type n) const
	Iterator advanced by n.
ConstIterator	operator- (difference_type n) const
	Iterator moved back by n.
difference_type	operator- (const ConstIterator &other) const
	Distance to other.
bool	operator== (const ConstIterator &other) const
	Equality.
bool	operator!= (const ConstIterator &other) const
	Inequality.

Friends
class	Iterable

Detailed Description

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

Const iterator adapter over Container::const_iterator.

Member Typedef Documentation

difference_type

template<typename Container >

using StormByte::Iterable< Container >::ConstIterator::difference_type = typename std::iterator_traits<typename Container::const_iterator>::difference_type

iterator_category

template<typename Container >

using StormByte::Iterable< Container >::ConstIterator::iterator_category = typename std::iterator_traits<typename Container::const_iterator>::iterator_category

Matches the underlying container iterator; not assumed random-access.

pointer

template<typename Container >

using StormByte::Iterable< Container >::ConstIterator::pointer = typename std::iterator_traits<typename Container::const_iterator>::pointer

reference

template<typename Container >

using StormByte::Iterable< Container >::ConstIterator::reference = typename std::iterator_traits<typename Container::const_iterator>::reference

value_type

template<typename Container >

using StormByte::Iterable< Container >::ConstIterator::value_type = typename std::iterator_traits<typename Container::const_iterator>::value_type

Member Function Documentation

operator!=()

template<typename Container >

bool StormByte::Iterable< Container >::ConstIterator::operator!=

(

const ConstIterator &

other

)

const

Inequality.

Parameters

other

Other iterator.

operator*()

template<typename Container >

reference StormByte::Iterable< Container >::ConstIterator::operator*

(

)

const

Dereference.

Returns

Const reference to the current element.

operator+()

template<typename Container >

ConstIterator StormByte::Iterable< Container >::ConstIterator::operator+

(

difference_type

n

)

const

Iterator advanced by n.

Parameters

n	Positions.

operator++() [1/2]

template<typename Container >

ConstIterator & StormByte::Iterable< Container >::ConstIterator::operator++

(

)

Pre-increment.

Returns

*this after advancing one.

operator++() [2/2]

template<typename Container >

ConstIterator StormByte::Iterable< Container >::ConstIterator::operator++

(

int

)

Post-increment.

Returns

Copy before advancing.

operator+=()

template<typename Container >

ConstIterator & StormByte::Iterable< Container >::ConstIterator::operator+=

(

difference_type

n

)

Advance in place.

Parameters

n	Positions (may be negative).

Returns

*this.

operator-() [1/2]

template<typename Container >

difference_type StormByte::Iterable< Container >::ConstIterator::operator-

(

const ConstIterator &

other

)

const

Distance to other.

Parameters

other

Iterator to subtract.

operator-() [2/2]

template<typename Container >

ConstIterator StormByte::Iterable< Container >::ConstIterator::operator-

(

difference_type

n

)

const

Iterator moved back by n.

Parameters

n	Positions.

operator--() [1/2]

template<typename Container >

ConstIterator & StormByte::Iterable< Container >::ConstIterator::operator--

(

)

Pre-decrement.

Returns

*this after moving back one.

operator--() [2/2]

template<typename Container >

ConstIterator StormByte::Iterable< Container >::ConstIterator::operator--

(

int

)

Post-decrement.

Returns

Copy before moving back.

operator-=()

template<typename Container >

ConstIterator & StormByte::Iterable< Container >::ConstIterator::operator-=

(

difference_type

n

)

Retreat in place.

Parameters

n	Positions (may be negative).

Returns

*this.

operator->()

template<typename Container >

pointer StormByte::Iterable< Container >::ConstIterator::operator->

(

)

const

Member access.

Returns

Const pointer to the current element.

operator==()

template<typename Container >

bool StormByte::Iterable< Container >::ConstIterator::operator==

(

const ConstIterator &

other

)

const

Equality.

Parameters

other

Other iterator.

Friends And Related Symbol Documentation

Iterable

template<typename Container >

friend class Iterable

friend

---

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

• lib/public/StormByte/iterable.hxx