Iterator

Description

Inherits from cons_iterator

This is an iterator type is commonly used as the function output type upon using iterators to alter the contents of the stack_vector where it returns an index pointing at a location of the new altered stack_vector.

Custom typenames

ValueType = typename stack_vector::ValueType

The type of typename T of stack_vector.

PointerType = ValueType*

The type pointer of typename T of stack_vector.

ReferenceType = ValueType&

The type reference of typename T of stack_vector.

---

Member Variables (inherited)

Name	Type	Visibility	Description
m_ptr	PointerType	private	This points to the address of m_data of stack_vector.

---

Allocation

iterator()

Default constructor

iterator(PointerType ptr)

Copy constructor which assigns m_ptr to point at the m_data of stack_vector<T>.

---

Accessor operators

ReferenceType operator[](const size_t index)

Allows to index the array pointed at m_data.

PointerType operator->()

Returns m_ptr.

ReferenceType operator*()

Returns reference to 'm_ptr'.

---

Arithmetical operators

iterator& operator++()

Prefix increment m_ptr.

iterator operator++(int)

Postfix increment m_ptr.

iterator& operator--()

Prefix decrement m_ptr.

iterator operator--(int)

Postfix decrement m_ptr.

iterator& operator+=(const size_t val)

Allows for indexing the array easily.

iterator operator+(const size_t val)

Allows for indexing the array easily.

iterator& operator-=(const size_t val)

Allows for indexing the array easily.

iterator operator-(const size_t val)

Allows for indexing the array easily.

---

Relational Operators

bool operator==(const iterator& other)

If m_ptr value is the same as other m_ptr.

bool operator!=(const iterator& other)

If m_ptr value is not the same as other m_ptr.

bool operator>=(const iterator& other)

If m_ptr value is greater than or equal to other m_ptr.

bool operator<=(const iterator& other)

If m_ptr value is less than or equal to other m_ptr.

bool operator>(const iterator& other)

If m_ptr value is greater than to other m_ptr.

bool operator<(const iterator& other)

If m_ptr value is less than to other m_ptr.