#include <Base/include/Framework/Collection/Iterator.hpp>
template<typename IType, typename T>
bpf::collection::Iterator class

Template parameters
IType the actual iterator type
T the target iterated value type

Contents

Non-constant iterator

Public functions

void operator+=(fsize i)
void operator-=(fsize i)
auto operator++() -> IType&
auto operator--() -> IType&
auto operator*() -> T&
auto operator->() -> T*
auto operator*() const -> const T&
auto operator->() const -> const T*
auto operator==(const IType& other) const -> bool noexcept
auto operator!=(const IType& other) const -> bool noexcept

Function documentation

template<typename IType, typename T>
void bpf::collection::Iterator<IType, T>::operator+=(fsize i)

Parameters
i how many steps should we advance

Advances this iterator forward

template<typename IType, typename T>
void bpf::collection::Iterator<IType, T>::operator-=(fsize i)

Parameters
i how many steps should we advance

Advances this iterator backward

template<typename IType, typename T>
IType& bpf::collection::Iterator<IType, T>::operator++()

Returns reference to iterator type

Increments this iterator to the next position

template<typename IType, typename T>
IType& bpf::collection::Iterator<IType, T>::operator--()

Returns reference to iterator type

Decrements this iterator to the previous position

template<typename IType, typename T>
T& bpf::collection::Iterator<IType, T>::operator*()

Returns mutable reference to T

Access to the value type at the current iterator position

template<typename IType, typename T>
T* bpf::collection::Iterator<IType, T>::operator->()

Returns mutable pointer to T

Access to the value type at the current iterator position

template<typename IType, typename T>
const T& bpf::collection::Iterator<IType, T>::operator*() const

Returns imutable reference to T

Access to the value type at the current iterator position

template<typename IType, typename T>
const T* bpf::collection::Iterator<IType, T>::operator->() const

Returns mutable pointer to T

Access to the value type at the current iterator position

template<typename IType, typename T>
bool bpf::collection::Iterator<IType, T>::operator==(const IType& other) const noexcept

Parameters
other operand
Returns true if this equals other, false otherwise

Compare Iterator

template<typename IType, typename T>
bool bpf::collection::Iterator<IType, T>::operator!=(const IType& other) const noexcept

Parameters
other operand
Returns true if this does not equal other, false otherwise

Compare Iterator