ARTS  2.4.0(git:4fb77825)
ConstIterator2D Class Reference

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

#include <matpackI.h>

Public Member Functions

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

Private Attributes

ConstVectorView msv
 Current position. More...
 
Index mstride {0}
 Row stride. More...
 

Detailed Description

The const 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 809 of file matpackI.h.

Constructor & Destructor Documentation

◆ ConstIterator2D() [1/2]

ConstIterator2D::ConstIterator2D ( )
default

Default constructor.

◆ ConstIterator2D() [2/2]

ConstIterator2D::ConstIterator2D ( const ConstVectorView x,
Index  stride 
)
inline

Explicit constructor.

Definition at line 816 of file matpackI.h.

Member Function Documentation

◆ operator!=()

bool ConstIterator2D::operator!= ( const ConstIterator2D other) const
inline

Not equal operator, needed for algorithms like copy.

Definition at line 828 of file matpackI.h.

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

◆ operator*()

const ConstVectorView& ConstIterator2D::operator* ( ) const
inline

Dereferencing.

Definition at line 841 of file matpackI.h.

References msv.

◆ operator++()

ConstIterator2D& ConstIterator2D::operator++ ( )
inline

Prefix increment operator.

Definition at line 822 of file matpackI.h.

References ConstVectorView::mdata, mstride, and msv.

◆ operator->()

const ConstVectorView* ConstIterator2D::operator-> ( ) const
inline

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

Definition at line 838 of file matpackI.h.

References msv.

Member Data Documentation

◆ mstride

Index ConstIterator2D::mstride {0}
private

Row stride.

Definition at line 847 of file matpackI.h.

Referenced by operator++().

◆ msv

ConstVectorView ConstIterator2D::msv
private

Current position.

Definition at line 845 of file matpackI.h.

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


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