#include <vctVarStrideMatrixIterator.h>

Inheritance diagram for vctVarStrideMatrixConstIterator< _elementType >:

Public Types
typedef vctVarStrideMatrixConstIterator< _elementType >	ThisType
typedef std::random_access_iterator_tag	iterator_category

Public Member Functions
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)
	vctVarStrideMatrixConstIterator ()
	vctVarStrideMatrixConstIterator (value_type *dataPtr, stride_type columnStride, size_type numColumns, stride_type rowStride, size_type initialColumn=0)
	vctVarStrideMatrixConstIterator (const value_type *dataPtr, difference_type columnStride, size_type numColumns, stride_type rowStride, size_type initialColumn=0)
ThisType &	operator++ ()
ThisType	operator++ (int)
ThisType &	operator-- ()
ThisType	operator-- (int)
ThisType &	operator+= (difference_type difference)
ThisType &	operator-= (difference_type difference)
difference_type	operator- (const ThisType &other) const
const value_type &	operator[] (difference_type index) const
const value_type &	operator* () const
bool	operator< (const ThisType &other) const
bool	operator<= (const ThisType &other) const
bool	operator== (const ThisType &other) const
bool	operator> (const ThisType &other) const
bool	operator>= (const ThisType &other) const
bool	operator!= (const ThisType &other) const

Protected Member Functions
void	WrapToRight ()
void	WrapToLeft ()

Protected Attributes
value_type *	DataPtr
stride_type	ColumnStride
difference_type	NumColumns
stride_type	RowStride
difference_type	CurrentColumn

Detailed Description

template<class _elementType>
class vctVarStrideMatrixConstIterator< _elementType >

Parameters

_elementType the type of the element that the iterator refers to.

See also: vctVarStrideMatrixIterator

Member Typedef Documentation

◆ iterator_category

template<class _elementType>

typedef std::random_access_iterator_tag vctVarStrideMatrixConstIterator< _elementType >::iterator_category

Type (i.e. category) of iterator, i.e. std::random_access_iterator_tag.

◆ ThisType

template<class _elementType>

typedef vctVarStrideMatrixConstIterator<_elementType> vctVarStrideMatrixConstIterator< _elementType >::ThisType

The type of the iterator itself.

Constructor & Destructor Documentation

◆ vctVarStrideMatrixConstIterator() [1/3]

template<class _elementType>

vctVarStrideMatrixConstIterator< _elementType >::vctVarStrideMatrixConstIterator ( )

inline

Default constructor: create an uninitialized object.

◆ vctVarStrideMatrixConstIterator() [2/3]

template<class _elementType>

vctVarStrideMatrixConstIterator< _elementType >::vctVarStrideMatrixConstIterator	(	value_type *	dataPtr,
		stride_type	columnStride,
		size_type	numColumns,
		stride_type	rowStride,
		size_type	initialColumn = 0 )

inline

Constructor taking a non-const element pointer. Note that only read operations will be performed!

◆ vctVarStrideMatrixConstIterator() [3/3]

template<class _elementType>

vctVarStrideMatrixConstIterator< _elementType >::vctVarStrideMatrixConstIterator	(	const value_type *	dataPtr,
		difference_type	columnStride,
		size_type	numColumns,
		stride_type	rowStride,
		size_type	initialColumn = 0 )

inline

Constructor taking a const element pointer. We need it in order to deal with const containers being refered by this iterator. We have to perform const_cast to convert back to the stored non-const member pointer of this iterator. However, the non-const iterator class completely shadows the constructors of the const-iterator base class, and so we don't have to worry about creating a non-const iterator over a const container.

Member Function Documentation

◆ operator!=()

template<class _elementType>

bool vctVarStrideMatrixConstIterator< _elementType >::operator!= ( const ThisType & other ) const

inline

Complementary operation to operator ==.

◆ operator*()

template<class _elementType>

const value_type & vctVarStrideMatrixConstIterator< _elementType >::operator* ( ) const

inline

Dereference (const).

◆ operator++() [1/2]

template<class _elementType>

ThisType & vctVarStrideMatrixConstIterator< _elementType >::operator++ ( )

inline

Pre-increment.

◆ operator++() [2/2]

template<class _elementType>

ThisType vctVarStrideMatrixConstIterator< _elementType >::operator++ ( int )

inline

Post-increment.

◆ operator+=()

template<class _elementType>

ThisType & vctVarStrideMatrixConstIterator< _elementType >::operator+= ( difference_type difference )

inline

Increment by offset.

Parameters

difference offset to increment by

◆ operator-()

template<class _elementType>

difference_type vctVarStrideMatrixConstIterator< _elementType >::operator- ( const ThisType & other ) const

inline

Subtraction between iterators returns the number of increments needed for the second operand to reach the first operand, if it is reachable.

The number of increments is found by the following equations: DataPtr - (difference / NumColumns) * RowStride + (difference % NumColumns) * ColumnStride == other.DataPtr DataPtr - other.DataPtr == (difference / NumColumns) * RowStride + (difference % NumColumns) * ColumnStride

if (RowStride >= NumColumns * ColumnStride) { (DataPtr - other.DataPtr) / RowStride == row_diff == (difference / NumColumns) DataPtr - other.DataPtr - row_diff * RowStride == (difference % NumColumns) * ColumnStride (DataPtr - other.DataPtr - row_diff * RowStride) / ColumnStride == col_diff == (difference % NumColumns) difference == row_diff * NumColumns + col_diff } otherwise switch the roles of rows and columns.

Note: this operation assumes reachability and does not test for it.

◆ operator--() [1/2]

template<class _elementType>

ThisType & vctVarStrideMatrixConstIterator< _elementType >::operator-- ( )

inline

Pre-decrement.

◆ operator--() [2/2]

template<class _elementType>

ThisType vctVarStrideMatrixConstIterator< _elementType >::operator-- ( int )

inline

Post-decrement.

◆ operator-=()

template<class _elementType>

ThisType & vctVarStrideMatrixConstIterator< _elementType >::operator-= ( difference_type difference )

inline

Decrement by offset.

Parameters

difference offset to decrement by

◆ operator<()

template<class _elementType>

bool vctVarStrideMatrixConstIterator< _elementType >::operator< ( const ThisType & other ) const

inline

Order relation between iterators, required by STL.

Note: The STL manual states that "if j is reachable from i then i<j". This does not imply the converse: "if i<j then j is reachable from i". In the case here, the converse does not hold.

◆ operator<=()

template<class _elementType>

bool vctVarStrideMatrixConstIterator< _elementType >::operator<= ( const ThisType & other ) const

inline

◆ operator==()

template<class _elementType>

bool vctVarStrideMatrixConstIterator< _elementType >::operator== ( const ThisType & other ) const

inline

Equality of iterators, required by STL.

◆ operator>()

template<class _elementType>

bool vctVarStrideMatrixConstIterator< _elementType >::operator> ( const ThisType & other ) const

inline

Complementary operation to operator <.

◆ operator>=()

template<class _elementType>

bool vctVarStrideMatrixConstIterator< _elementType >::operator>= ( const ThisType & other ) const

inline

◆ operator[]()

template<class _elementType>

const value_type & vctVarStrideMatrixConstIterator< _elementType >::operator[] ( difference_type index ) const

inline

Random access (return const reference).

◆ VCT_CONTAINER_TRAITS_TYPEDEFS()

template<class _elementType>

vctVarStrideMatrixConstIterator< _elementType >::VCT_CONTAINER_TRAITS_TYPEDEFS ( _elementType )

◆ WrapToLeft()

template<class _elementType>

void vctVarStrideMatrixConstIterator< _elementType >::WrapToLeft ( )

inlineprotected

An auxiliary method to wrap the column index of the iterator. If the current column is negative, move one row up, and wrap to the corresponding column starting from the right

◆ WrapToRight()

template<class _elementType>

void vctVarStrideMatrixConstIterator< _elementType >::WrapToRight ( )

inlineprotected

An auxiliary method to wrap the column index of the iterator. If the current column exceeds the number of columns in the matrix, more one row down and wrap to the corresponding column starting from the left

Member Data Documentation

◆ ColumnStride

template<class _elementType>

stride_type vctVarStrideMatrixConstIterator< _elementType >::ColumnStride

protected

◆ CurrentColumn

template<class _elementType>

difference_type vctVarStrideMatrixConstIterator< _elementType >::CurrentColumn

protected

◆ DataPtr

template<class _elementType>

value_type* vctVarStrideMatrixConstIterator< _elementType >::DataPtr

protected

The data member points to the object being refered by this iterator. It is not declared const, so we will be able to use it in the non-const iterator class. But all the methods in vctVarStrideMatrixConstIterator are declared const to protect the data from writing.

◆ NumColumns

template<class _elementType>

difference_type vctVarStrideMatrixConstIterator< _elementType >::NumColumns

protected

◆ RowStride

template<class _elementType>

stride_type vctVarStrideMatrixConstIterator< _elementType >::RowStride

protected

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

tmp/cisst-saw/cisst/cisstVector/vctVarStrideMatrixIterator.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ iterator_category

◆ ThisType

Constructor & Destructor Documentation

◆ vctVarStrideMatrixConstIterator() [1/3]

◆ vctVarStrideMatrixConstIterator() [2/3]

◆ vctVarStrideMatrixConstIterator() [3/3]

Member Function Documentation

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator-()

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator>()

◆ operator>=()

◆ operator[]()

◆ VCT_CONTAINER_TRAITS_TYPEDEFS()

◆ WrapToLeft()

◆ WrapToRight()

Member Data Documentation

◆ ColumnStride

◆ CurrentColumn

◆ DataPtr

◆ NumColumns

◆ RowStride