ConstIterator1D Class Reference

The constant iterator class for sub vectors. More...

#include <matpackI.h>

Public Types
using	difference_type = Index
using	value_type = const Numeric
using	pointer = const Numeric *
using	reference = const Numeric &
using	iterator_category = std::random_access_iterator_tag

Public Member Functions
	ConstIterator1D ()=default
	Default constructor.
	ConstIterator1D (const Numeric *x, Index stride) ARTS_NOEXCEPT
	Explicit constructor.
ConstIterator1D &	operator++ () ARTS_NOEXCEPT
	Prefix increment operator.
const Numeric &	operator* () const ARTS_NOEXCEPT
	Dereferencing.
bool	operator!= (const ConstIterator1D &other) const ARTS_NOEXCEPT
	Not equal operator, needed for algorithms like copy.
bool	operator== (const ConstIterator1D &other) const ARTS_NOEXCEPT
Index	operator- (const ConstIterator1D &other) const ARTS_NOEXCEPT

Private Attributes
const Numeric *	mx {nullptr}
	Current position.
Index	mstride {0}
	Stride.

Friends
void	copy (ConstIterator1D origin, const ConstIterator1D &end, Iterator1D target)

Detailed Description

The constant iterator class for sub vectors.

This takes into account the defined stride.

Definition at line 458 of file matpackI.h.

Member Typedef Documentation

difference_type

using ConstIterator1D::difference_type = Index

Definition at line 460 of file matpackI.h.

iterator_category

using ConstIterator1D::iterator_category = std::random_access_iterator_tag

Definition at line 464 of file matpackI.h.

pointer

using ConstIterator1D::pointer = const Numeric*

Definition at line 462 of file matpackI.h.

reference

using ConstIterator1D::reference = const Numeric&

Definition at line 463 of file matpackI.h.

value_type

using ConstIterator1D::value_type = const Numeric

Definition at line 461 of file matpackI.h.

Constructor & Destructor Documentation

ConstIterator1D() [1/2]

ConstIterator1D::ConstIterator1D ( )

default

Default constructor.

ConstIterator1D() [2/2]

ConstIterator1D::ConstIterator1D ( const Numeric *  x, Index  stride  )

inline

Explicit constructor.

Definition at line 470 of file matpackI.h.

Member Function Documentation

operator!=()

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

inline

Not equal operator, needed for algorithms like copy.

Definition at line 486 of file matpackI.h.

References mx.

Referenced by operator==().

operator*()

const Numeric & ConstIterator1D::operator* ( ) const

inline

Dereferencing.

Definition at line 483 of file matpackI.h.

References mx.

operator++()

ConstIterator1D & ConstIterator1D::operator++ ( )

inline

Prefix increment operator.

Definition at line 477 of file matpackI.h.

References mstride, and mx.

operator-()

Index ConstIterator1D::operator- ( const ConstIterator1D &  other ) const

inline

Definition at line 495 of file matpackI.h.

References mstride, and mx.

operator==()

bool ConstIterator1D::operator== ( const ConstIterator1D &  other ) const

inline

Definition at line 491 of file matpackI.h.

References operator!=().

Friends And Related Function Documentation

copy

void copy ( ConstIterator1D  origin, const ConstIterator1D &  end, Iterator1D  target  )

friend

Target must be a valid area of memory. Note that the strides in the iterators can be different, so that we can for example copy data between different kinds of subvectors.

Definition at line 288 of file matpackI.cc.

Member Data Documentation

mstride

Index ConstIterator1D::mstride {0}

private

Stride.

Definition at line 507 of file matpackI.h.

Referenced by operator++(), and operator-().

mx

const Numeric* ConstIterator1D::mx {nullptr}

private

Current position.

Definition at line 505 of file matpackI.h.

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

---

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

• matpackI.h