ARTS 2.5.4 (git: 4c0d3b4d)
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) ARTS_NOEXCEPT
 Explicit constructor. More...
 
Iterator2Doperator++ () ARTS_NOEXCEPT
 Prefix increment operator. More...
 
bool operator!= (const Iterator2D &other) const ARTS_NOEXCEPT
 Not equal operator, needed for algorithms like copy. More...
 
VectorViewoperator-> () ARTS_NOEXCEPT
 The -> operator is needed, so that we can write i->begin() to get the 1D iterators. More...
 
VectorViewoperator* () ARTS_NOEXCEPT
 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 813 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 820 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 833 of file matpackI.h.

◆ operator*()

VectorView & Iterator2D::operator* ( )
inline

Dereferencing.

Definition at line 845 of file matpackI.h.

◆ operator++()

Iterator2D & Iterator2D::operator++ ( )
inline

Prefix increment operator.

Definition at line 827 of file matpackI.h.

◆ operator->()

VectorView * Iterator2D::operator-> ( )
inline

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

Definition at line 842 of file matpackI.h.

Member Data Documentation

◆ mstride

Index Iterator2D::mstride {0}
private

Row stride.

Definition at line 851 of file matpackI.h.

◆ msv

VectorView Iterator2D::msv
private

Current position.

Definition at line 849 of file matpackI.h.


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