Iterator2D Class Reference

The row iterator class for sub matrices. More...

#include <matpackI.h>

Public Member Functions
	Iterator2D ()=default
	Default constructor. More...
	Iterator2D (const VectorView &x, Index stride)
	Explicit constructor. More...
Iterator2D &	operator++ ()
	Prefix increment operator. More...
bool	operator!= (const Iterator2D &other) const
	Not equal operator, needed for algorithms like copy. More...
VectorView *	operator-> ()
	The -> operator is needed, so that we can write i->begin() to get the 1D iterators. More...
VectorView &	operator* ()
	Dereferencing. More...

Private Attributes
VectorView	msv
	Current position. More...
Index	mstride {0}
	Row stride. More...

Detailed Description

The row iterator class for sub matrices.

This takes into account the defined row stride. The iterator points to a row of the matrix, which acts just like a VectorView.

Definition at line 765 of file matpackI.h.

Constructor & Destructor Documentation

Iterator2D() [1/2]

Iterator2D::Iterator2D ( )

default

Default constructor.

Iterator2D() [2/2]

Iterator2D::Iterator2D ( const VectorView &  x, Index  stride  )

inline

Explicit constructor.

Definition at line 772 of file matpackI.h.

Member Function Documentation

operator!=()

bool Iterator2D::operator!= ( const Iterator2D &  other ) const

inline

Not equal operator, needed for algorithms like copy.

Definition at line 784 of file matpackI.h.

References ConstVectorView::mdata, ConstVectorView::mrange, Range::mstart, and msv.

operator*()

VectorView& Iterator2D::operator* ( )

inline

Dereferencing.

Definition at line 797 of file matpackI.h.

References msv.

operator++()

Iterator2D& Iterator2D::operator++ ( )

inline

Prefix increment operator.

Definition at line 778 of file matpackI.h.

References ConstVectorView::mdata, mstride, and msv.

operator->()

VectorView* Iterator2D::operator-> ( )

inline

The -> operator is needed, so that we can write i->begin() to get the 1D iterators.

Definition at line 794 of file matpackI.h.

References msv.

Member Data Documentation

mstride

Index Iterator2D::mstride {0}

private

Row stride.

Definition at line 803 of file matpackI.h.

Referenced by operator++().

msv

VectorView Iterator2D::msv

private

Current position.

Definition at line 801 of file matpackI.h.

Referenced by operator!=(), operator*(), operator++(), and operator->().

---

The documentation for this class was generated from the following file:

• matpackI.h