File iterator_diagonal.hpp

namespace boosting

template<typename T>
class DiagonalIterator

#include <iterator_diagonal.hpp>

An iterator that provides access to the elements that correspond to the diagonal of a C-contiguous square matrix.

Template Parameters:

T – The type of the elements that are stored in the matrix

Public Types

using difference_type = int

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

using value_type = View<T>::value_type

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

using pointer = View<T>::value_type*

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

using reference = View<T>::value_type&

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 DiagonalIterator(View<T> view, uint32 index)

Parameters:

• view – A View that provides access to the elements in the matrix

• index – The index on the diagonal to start at

inline reference 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 reference operator[](uint32 index)

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 reference operator*() const

Returns the element, the iterator currently refers to.

Returns:

The element, the iterator currently refers to

inline reference operator*()

Returns the element, the iterator currently refers to.

Returns:

The element, the iterator currently refers to

inline DiagonalIterator<T> &operator++()

Returns an iterator to the next element.

Returns:

A reference to an iterator to the next element

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

Returns an iterator to the next element.

Returns:

A reference to an iterator to the next element

inline DiagonalIterator<T> &operator--()

Returns an iterator to the previous element.

Returns:

A reference to an iterator to the previous element

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

Returns an iterator to the previous element.

Returns:

A reference to an iterator to the previous element

inline bool operator!=(const DiagonalIterator<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 DiagonalIterator<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 DiagonalIterator<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

View<T> view_

uint32 index_