File diagonal_iterator.hpp

namespace boosting

template<typename T>
class DiagonalConstIterator

#include <diagonal_iterator.hpp>

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

Template Parameters:

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

Public Types

typedef int difference_type

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

typedef T value_type

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

typedef const T *pointer

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

typedef const T &reference

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

typedef std::random_access_iterator_tag iterator_category

The tag that specifies the capabilities of the iterator.

Public Functions

inline DiagonalConstIterator(typename View<T>::const_iterator iterator, uint32 index)

Parameters:

• iterator – An iterator to the beginning of 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*() const

Returns the element, the iterator currently refers to.

Returns:

The element, the iterator currently refers to

inline DiagonalConstIterator<T> &operator++()

Returns an iterator to the next element.

Returns:

A reference to an iterator to the next element

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

Returns an iterator to the next element.

Returns:

A reference to an iterator to the next element

inline DiagonalConstIterator<T> &operator--()

Returns an iterator to the previous element.

Returns:

A reference to an iterator to the previous element

inline DiagonalConstIterator<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 DiagonalConstIterator<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 DiagonalConstIterator<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 DiagonalConstIterator<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>::const_iterator iterator_

uint32 index_