File iterator_equal.hpp

template<typename T>
class EqualIterator

#include <iterator_equal.hpp>

An iterator that provides random read-only access to a constant value.

Template Parameters:

T – The type of the constant value

Public Types

using difference_type = int

The type that is used to represent the difference between two iterators.

using value_type = T

The type of the elements, the iterator provides access to.

using pointer = const T*

The type of a pointer to an element, the iterator provides access to.

using reference = T&

The type of a reference to an element, the iterator provides access to.

using iterator_category = std::random_access_iterator_tag

The tag that specifies the capabilities of the iterator.

Public Functions

inline EqualIterator(T value)

Parameters:

value – The constant value

inline EqualIterator(T value, uint32 startIndex)

Parameters:

• value – The constant value

• startIndex – The index to start with

inline value_type operator[](uint32 index) const

Returns the element at a specific index.

Parameters:

index – The index of the element to be returned

Returns:

The element at the given index

inline value_type operator*() const

Returns the element, the iterator currently refers to.

Returns:

The element, the iterator currently refers to

inline EqualIterator<T> &operator++()

Returns an iterator to the next element.

Returns:

A reference to an iterator that refers to the next element

inline EqualIterator<T> &operator++(int n)

Returns an iterator to the next element.

Returns:

A reference to an iterator that refers to the next element

inline EqualIterator<T> &operator--()

Returns an iterator to the previous element.

Returns:

A reference to an iterator that refers to the previous element

inline EqualIterator<T> &operator--(int n)

Returns an iterator to the previous element.

Returns:

A reference to an iterator that refers to the previous element

inline bool operator!=(const EqualIterator<T> &rhs) const

Returns whether this iterator and another one refer to the same element.

Parameters:

rhs – A reference to another iterator

Returns:

True, if the iterators do not refer to the same element, false otherwise

inline bool operator==(const EqualIterator<T> &rhs) const

Returns whether this iterator and another one refer to the same element.

Parameters:

rhs – A reference to another iterator

Returns:

True, if the iterators refer to the same element, false otherwise

inline difference_type operator-(const EqualIterator<T> &rhs) const

Returns the difference between this iterator and another one.

Parameters:

rhs – A reference to another iterator

Returns:

The difference between the iterators

Private Members

const T value_

uint32 index_