Inherits ltl::LTLIterator.

Inherited by ltl::MArrayIter< T, N >.

Public Types
enum	{ dims =N }
	These define constants that are used by the expression template engine. More...

enum	{ numIndexIter = 0 }

enum	{ numConvolution = 0 }

enum	{ isVectorizable = 1 }

typedef std::forward_iterator_tag	iterator_category
	`std::iterator` typedefs More...

typedef int	difference_type

typedef MArray< T, N >::value_type	value_type

typedef MArray< T, N > ::const_reference	const_reference

typedef MArray< T, N > ::const_pointer	const_pointer

typedef MArray< T, N >::reference	reference

typedef MArray< T, N >::pointer	pointer

Public Member Functions
	MArrayIterConst (const MArray< T, N > &array)
	Construct an `iterator` for a given ltl::MArray. This will rarely be called by a user. More...

	MArrayIterConst (const MArray< T, N > &array, const _iter_end_tag &E)
	Construct an `end-iterator` for a given ltl::MArray. This will rarely be called by a user. More...

	MArrayIterConst (const MArrayIterConst< T, N > &other)
	copy constructor More...

void	reset ()
	Reset the iterator back to the first element. More...

value_type	operator* () const
	Dereference the iterator object. Return the element pointed to. More...

MArrayIterConst< T, N > &	operator++ ()
	Move the iterator to the next object. More...

void	operator++ (int)
	Postfix `operator++()`. More...

bool	operator== (const MArrayIterConst< T, N > &other) const
	`true` if iterators share the same data pointer More...

bool	operator!= (const MArrayIterConst< T, N > &other) const
	`true` if iterators do not share the same data pointer More...

bool	done () const
	True if we point past the end, i.e. we are equal to the end iterator. More...

bool	isConformable (const Shape< N > &other) const
	`true` if we have the same array geometry as that of `other`, More...

void	printRanges () const
	Pretty print the geometry. More...

const Shape< N > *	shape () const
	Return our `shape`. More...

bool	isStorageContiguous () const
	`true` if the memory we are pointing to has contiguous memory layout. More...

bool	isStride1 () const
	`true` if our innermost stride is 1 More...

value_type *	data () const
	Return the current data pointer. More...


void	advance ()
	Provide separate versions of advance() for incrementing the innermost. More...

void	advance (int n)
	Unconditionally increase the data pointer by N innermost strides. More...

void	advance (int n, int dim)
	Unconditionally increase the data pointer by N along dimension dim (used for partial reductions). More...

void	advanceWithStride1 ()
	Unconditionally increase the data pointer by one. More...

bool	needAdvanceDim () const
	Check if we have reached the end of the innermost dimension. More...

void	advanceDim ()
	Advance the iterator past the end of one "line" (the end of the innermost dimension). More...

void	advanceDim (const int cutDim)
	Advance the iterator past the end of one "line", ignoring the dimension cutDim (used in partial reductions). More...


value_type	readWithoutStride (const int i) const
	Read the data value at the current location + i (optimized for stride 1). More...

value_type	readWithStride (const int i) const
	Read the current data value at the current location + i*stride. More...

value_type	readWithStride (const int i, const int dim) const
	Read the data value at position i along dimension dim (used in partial reductions) More...

value_type	readAtOffsetDim (const int i, const int dim) const
	Read the data value at offset i along dim dim (used in convolutions) More...

value_type	readAtOffset (const int i) const
	Read the data value at offset i along dim 1 (used in convolutions) More...

value_type	readAtOffset (const int i, const int j) const
	Read the data value at offset i along dim 1 and j along dim 2 (used in convolutions) More...

value_type	readAtOffset (const int i, const int j, const int k) const
	Read the data value at offset i along dim 1, j along dim 2, and k along dim 3 (used in convolutions) More...

int	boundary_l (const int dim) const
	leave boundary around the lower edges of the array (for convolutions) More...

int	boundary_u (const int dim) const
	leave boundary around the upper edges of the array (for convolutions) More...

Protected Attributes
value_type *restrict_	data_

const MArray< T, N > *	array_

value_type *	stack_ [N]

value_type *	last_ [N]

int	strides_ [N]

int	length_ [N]

const int	stride_

Detailed Description

template<typename T, int N>
class ltl::MArrayIterConst< T, N >

Const iterator object for ltl::MArrays. Conforms to std::forward_iterator. The non-const version is implemented below by inheriting from this class.

Constructor & Destructor Documentation

template<typename T, int N>

ltl::MArrayIterConst< T, N >::MArrayIterConst ( const MArray< T, N > & array )

Construct an iterator for a given ltl::MArray. This will rarely be called by a user.

template<typename T, int N>

ltl::MArrayIterConst< T, N >::MArrayIterConst	(	const MArray< T, N > &	array,
		const _iter_end_tag &	E
	)

inline

Construct an end-iterator for a given ltl::MArray. This will rarely be called by a user.

References ltl::MArray< T, N >::data(), ltl::MArrayIterConst< T, N >::data_, ltl::MArrayIterConst< T, N >::last_, ltl::MArray< T, N >::nelements(), and ltl::MArrayIterConst< T, N >::stride_.

template<typename T, int N>

ltl::MArrayIterConst< T, N >::MArrayIterConst ( const MArrayIterConst< T, N > & other )

inline

copy constructor

References ltl::MArrayIterConst< T, N >::last_, ltl::MArrayIterConst< T, N >::length_, ltl::MArrayIterConst< T, N >::stack_, and ltl::MArrayIterConst< T, N >::strides_.

Member Function Documentation

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::reset ( )

Reset the iterator back to the first element.

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::operator* ( ) const

inline

Dereference the iterator object. Return the element pointed to.

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::done().

template<typename T, int N>

MArrayIterConst<T,N>& ltl::MArrayIterConst< T, N >::operator++ ( )

inline

Move the iterator to the next object.

This method will almost never be used. Instead, more efficient versions will be used by the expression template engine to move iterators forward.

This implementation of operator++() will check for the end condition every time it is called. When we evaluate an expression, all iterators involved in the expression point to MArrays or expressions of the same geometry, so checking for the end condition on ONE of the iterators is enough. We also know the length of the dimension(s), so we can optimize the increment past the end of one dimension (where we have to reset this dimension and use a different stride to increment the next-outer dimension). See below and implementation of evaluation methods in ltl/marray/eval.h.

References ltl::MArrayIterConst< T, N >::advance(), ltl::MArrayIterConst< T, N >::advanceDim(), ltl::MArrayIterConst< T, N >::data_, ltl::MArrayIterConst< T, N >::done(), and ltl::MArrayIterConst< T, N >::last_.

Referenced by ltl::MArrayIter< T, N >::operator++().

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::operator++ ( int )

inline

Postfix operator++().

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::advance ( )

inline

Provide separate versions of advance() for incrementing the innermost.

When evaluating an expression involving more than one iterator all terms MUST have the same geometry, the loop structures are identical. It's therefore sufficient to check the end of loop condition and the end of one dimension on one of the iterators ... All others are then 'remote controlled' via these methods methods. See implementation of evaluation methods in ltl/marray/eval.h.Unconditionally increase the data pointer by one innermost stride.

Referenced by ltl::MArrayIterConst< T, N >::operator++().

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::advance ( int n )

inline

Unconditionally increase the data pointer by N innermost strides.

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::stride_.

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::advance	(	int	n,
		int	dim
	)

inline

Unconditionally increase the data pointer by N along dimension dim (used for partial reductions).

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::strides_.

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::advanceWithStride1 ( )

inline

Unconditionally increase the data pointer by one.

References ltl::MArrayIterConst< T, N >::data_.

template<typename T, int N>

bool ltl::MArrayIterConst< T, N >::needAdvanceDim ( ) const

inline

Check if we have reached the end of the innermost dimension.

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::last_.

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::advanceDim ( )

Advance the iterator past the end of one "line" (the end of the innermost dimension).

Referenced by ltl::MArrayIterConst< T, N >::operator++().

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::advanceDim ( const int cutDim )

Advance the iterator past the end of one "line", ignoring the dimension cutDim (used in partial reductions).

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::readWithoutStride ( const int i ) const

inline

Read the data value at the current location + i (optimized for stride 1).

These methods are for implementing loop unrolling and vectorization for the efficient evaluation of expression templates.

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::readWithStride ( const int i ) const

inline

Read the current data value at the current location + i*stride.

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::stride_.

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::readWithStride	(	const int	i,
		const int	dim
	)		const

inline

Read the data value at position i along dimension dim (used in partial reductions)

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::strides_.

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::readAtOffsetDim	(	const int	i,
		const int	dim
	)		const

inline

Read the data value at offset i along dim dim (used in convolutions)

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::strides_.

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::readAtOffset ( const int i ) const

inline

Read the data value at offset i along dim 1 (used in convolutions)

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::stride_.

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::readAtOffset	(	const int	i,
		const int	j
	)		const

inline

Read the data value at offset i along dim 1 and j along dim 2 (used in convolutions)

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::strides_.

template<typename T, int N>

value_type ltl::MArrayIterConst< T, N >::readAtOffset	(	const int	i,
		const int	j,
		const int	k
	)		const

inline

Read the data value at offset i along dim 1, j along dim 2, and k along dim 3 (used in convolutions)

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::strides_.

template<typename T, int N>

int ltl::MArrayIterConst< T, N >::boundary_l ( const int dim ) const

inline

leave boundary around the lower edges of the array (for convolutions)

template<typename T, int N>

int ltl::MArrayIterConst< T, N >::boundary_u ( const int dim ) const

inline

leave boundary around the upper edges of the array (for convolutions)

template<typename T, int N>

bool ltl::MArrayIterConst< T, N >::operator== ( const MArrayIterConst< T, N > & other ) const

inline

true if iterators share the same data pointer

References ltl::MArrayIterConst< T, N >::data_.

template<typename T, int N>

bool ltl::MArrayIterConst< T, N >::operator!= ( const MArrayIterConst< T, N > & other ) const

inline

true if iterators do not share the same data pointer

References ltl::MArrayIterConst< T, N >::data_.

template<typename T, int N>

bool ltl::MArrayIterConst< T, N >::done ( ) const

inline

True if we point past the end, i.e. we are equal to the end iterator.

References ltl::MArrayIterConst< T, N >::data_, and ltl::MArrayIterConst< T, N >::last_.

Referenced by ltl::average_clip_median(), ltl::PolynomFit< TPAR, TDAT, ORDER, EXT, 1 >::eval(), ltl::PolynomFit< TPAR, TDAT, ORDER, EXT, 1 >::fill(), ltl::median_clip_average(), ltl::MArrayIterConst< T, N >::operator*(), ltl::MArrayIter< T, N >::operator*(), ltl::MArrayIterConst< T, N >::operator++(), and ltl::MArray< T, N >::operator>>().

template<typename T, int N>

bool ltl::MArrayIterConst< T, N >::isConformable ( const Shape< N > & other ) const

inline

true if we have the same array geometry as that of other,

References ltl::MArrayIterConst< T, N >::shape().

template<typename T, int N>

void ltl::MArrayIterConst< T, N >::printRanges ( ) const

Pretty print the geometry.

template<typename T, int N>

const Shape<N>* ltl::MArrayIterConst< T, N >::shape ( ) const

inline

Return our shape.

References ltl::MArrayIterConst< T, N >::array_.

Referenced by ltl::MArrayIterConst< T, N >::isConformable(), and ltl::MArrayIterConst< T, N >::isStorageContiguous().

template<typename T, int N>

bool ltl::MArrayIterConst< T, N >::isStorageContiguous ( ) const

inline

true if the memory we are pointing to has contiguous memory layout.

References ltl::MArrayIterConst< T, N >::shape().

template<typename T, int N>

bool ltl::MArrayIterConst< T, N >::isStride1 ( ) const

inline

true if our innermost stride is 1

References ltl::MArrayIterConst< T, N >::stride_.

template<typename T, int N>

value_type* ltl::MArrayIterConst< T, N >::data ( ) const

inline

Return the current data pointer.

References ltl::MArrayIterConst< T, N >::data_.

Member Data Documentation

template<typename T, int N>

value_type* restrict_ ltl::MArrayIterConst< T, N >::data_

protected

template<typename T, int N>

const MArray<T,N>* ltl::MArrayIterConst< T, N >::array_

protected

Referenced by ltl::MArrayIterConst< T, N >::shape().

template<typename T, int N>

value_type* ltl::MArrayIterConst< T, N >::stack_[N]

protected

Referenced by ltl::MArrayIterConst< T, N >::MArrayIterConst().

template<typename T, int N>

value_type * ltl::MArrayIterConst< T, N >::last_[N]

protected

Referenced by ltl::MArrayIterConst< T, N >::done(), ltl::MArrayIterConst< T, N >::MArrayIterConst(), ltl::MArrayIterConst< T, N >::needAdvanceDim(), and ltl::MArrayIterConst< T, N >::operator++().

template<typename T, int N>

int ltl::MArrayIterConst< T, N >::strides_[N]

protected

Referenced by ltl::MArrayIterConst< T, N >::advance(), ltl::MArrayIterConst< T, N >::MArrayIterConst(), ltl::MArrayIterConst< T, N >::readAtOffset(), ltl::MArrayIterConst< T, N >::readAtOffsetDim(), and ltl::MArrayIterConst< T, N >::readWithStride().

template<typename T, int N>

int ltl::MArrayIterConst< T, N >::length_[N]

protected

Referenced by ltl::MArrayIterConst< T, N >::MArrayIterConst().

template<typename T, int N>

const int ltl::MArrayIterConst< T, N >::stride_

protected

Referenced by ltl::MArrayIterConst< T, N >::advance(), ltl::MArrayIterConst< T, N >::isStride1(), ltl::MArrayIterConst< T, N >::MArrayIterConst(), ltl::MArrayIterConst< T, N >::readAtOffset(), and ltl::MArrayIterConst< T, N >::readWithStride().

Public Types

Public Member Functions

Protected Attributes

Detailed Description

template<typename T, int N> class ltl::MArrayIterConst< T, N >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename T, int N>
class ltl::MArrayIterConst< T, N >