cisst-saw: vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride > Class Template Reference

#include <vctFixedStrideMatrixIterator.h>

Inheritance diagram for vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >:

Public Types
typedef vctFixedStrideMatrixIterator < _elementType, _columnStride, _numColumns, _rowStride >	ThisType

typedef vctFixedStrideMatrixConstIterator < _elementType, _columnStride, _numColumns, _rowStride >	BaseType

typedef BaseType::iterator_category	iterator_category

Public Types inherited from vctFixedStrideMatrixConstIterator< _elementType, _columnStride, _numColumns, _rowStride >
enum	{ COL_STRIDE = _columnStride, ROW_STRIDE = _rowStride }

enum	{ NUM_COLUMNS = _numColumns }

typedef vctFixedStrideMatrixConstIterator < _elementType, _columnStride, _numColumns, _rowStride >	ThisType

typedef std::iterator < std::random_access_iterator_tag, _elementType >	BaseType

typedef BaseType::iterator_category	iterator_category

Public Member Functions
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)

	vctFixedStrideMatrixIterator ()

	vctFixedStrideMatrixIterator (value_type *dataPtr, index_type initialColumn=0)

ThisType &	operator++ ()

ThisType	operator++ (int)

ThisType &	operator-- ()

ThisType	operator-- (int)

ThisType &	operator+= (difference_type difference)

ThisType &	operator-= (difference_type difference)

value_type &	operator[] (difference_type index) const

value_type &	operator* ()

Public Member Functions inherited from vctFixedStrideMatrixConstIterator< _elementType, _columnStride, _numColumns, _rowStride >
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)

	vctFixedStrideMatrixConstIterator ()

	vctFixedStrideMatrixConstIterator (value_type *dataPtr, index_type initialColumn=0)

	vctFixedStrideMatrixConstIterator (const value_type *dataPtr, index_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

Additional Inherited Members
Protected Types inherited from vctFixedStrideMatrixConstIterator< _elementType, _columnStride, _numColumns, _rowStride >
enum	{ ROW_FIRST_INDEX = (ROW_STRIDE >= NUM_COLUMNS * COL_STRIDE) }

Protected Member Functions inherited from vctFixedStrideMatrixConstIterator< _elementType, _columnStride, _numColumns, _rowStride >
void	WrapToRight ()

void	WrapToLeft ()

Protected Attributes inherited from vctFixedStrideMatrixConstIterator< _elementType, _columnStride, _numColumns, _rowStride >
value_type *	DataPtr

difference_type	CurrentColumn

Detailed Description

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>
class vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >

See Also: vctFixedStrideMatrixConstIterator

Member Typedef Documentation

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

typedef vctFixedStrideMatrixConstIterator<_elementType, _columnStride, _numColumns, _rowStride> vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::BaseType

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

typedef BaseType::iterator_category vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::iterator_category

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

typedef vctFixedStrideMatrixIterator<_elementType, _columnStride, _numColumns, _rowStride> vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::ThisType

Constructor & Destructor Documentation

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::vctFixedStrideMatrixIterator ( )

inline

Default constructor: create an uninitialized object

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::vctFixedStrideMatrixIterator	(	value_type *	dataPtr,
		index_type	initialColumn = `0`
	)

inlineexplicit

Constructor taking a non-const element pointer. Read and write operations on the refered object are permitted. Note that there is no constructor that takes a const element pointer.

Member Function Documentation

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

value_type& vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator* ( )

inline

Add non-const version of unary operator *

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

ThisType& vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator++ ( )

inline

Redefine operator++ to return vctFixedStrideMatrixIterator instead of vctFixedStrideMatrixConstIterator

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

ThisType vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator++ ( int )

inline

Redefine operator++ to return vctFixedStrideMatrixIterator instead of vctFixedStrideMatrixConstIterator

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

ThisType& vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator+= ( difference_type difference )

inline

Redefine operator+= to return vctArrayIterator instead of vctArrayConstIterator

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

ThisType& vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator-- ( )

inline

Redefine operator-- to return vctFixedStrideMatrixIterator instead of vctFixedStrideMatrixConstIterator

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

ThisType vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator-- ( int )

inline

Redefine operator-- to return vctFixedStrideMatrixIterator instead of vctFixedStrideMatrixConstIterator

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

ThisType& vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator-= ( difference_type difference )

inline

Redefine operator-= to return vctArrayIterator instead of vctArrayConstIterator

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

value_type& vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::operator[] ( difference_type index ) const

inline

Add non-const version of operator []

template<class _elementType, vct::stride_type _columnStride, vct::index_type _numColumns, vct::stride_type _rowStride>

vctFixedStrideMatrixIterator< _elementType, _columnStride, _numColumns, _rowStride >::VCT_CONTAINER_TRAITS_TYPEDEFS ( _elementType )

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstVector/vctFixedStrideMatrixIterator.h