ConstComplexIterator1D Class Reference

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

#include <complex.h>

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

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

Friends
void	copy (ConstComplexIterator1D origin, const ConstComplexIterator1D &end, ComplexIterator1D target)
	Copy data between begin and end to target. More...

Detailed Description

The constant iterator class for sub vectors.

This takes into account the defined stride.

Definition at line 218 of file complex.h.

Constructor & Destructor Documentation

ConstComplexIterator1D() [1/2]

ConstComplexIterator1D::ConstComplexIterator1D ( )

default

Default constructor.

ConstComplexIterator1D() [2/2]

ConstComplexIterator1D::ConstComplexIterator1D ( Complex *  x, Index  stride  )

inline

Explicit constructor.

Definition at line 224 of file complex.h.

Member Function Documentation

operator!=()

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

inline

Not equal operator, needed for algorithms like copy.

Definition at line 239 of file complex.h.

References mx.

operator*()

const Complex& ConstComplexIterator1D::operator* ( ) const

inline

Dereferencing.

Definition at line 236 of file complex.h.

References mx.

operator++()

ConstComplexIterator1D& ConstComplexIterator1D::operator++ ( )

inline

Prefix increment operator.

Definition at line 230 of file complex.h.

References mstride, and mx.

Friends And Related Function Documentation

copy

void copy ( ConstComplexIterator1D  origin, const ConstComplexIterator1D &  end, ComplexIterator1D  target  )

friend

Copy data between begin and end to target.

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 478 of file complex.cc.

Member Data Documentation

mstride

Index ConstComplexIterator1D::mstride {0}

private

Stride.

Definition at line 254 of file complex.h.

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

mx

const Complex* ConstComplexIterator1D::mx {nullptr}

private

Current position.

Definition at line 252 of file complex.h.

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

---

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

• complex.h