vctVarStrideMatrixIterator< _elementType > Class Template Reference

#include <vctVarStrideMatrixIterator.h>

Inheritance diagram for vctVarStrideMatrixIterator< _elementType >:

Public Types
typedef vctVarStrideMatrixIterator< _elementType >	ThisType
typedef vctVarStrideMatrixConstIterator< _elementType >	BaseType
typedef BaseType::iterator_category	iterator_category
Public Types inherited from vctVarStrideMatrixConstIterator< _elementType >
typedef vctVarStrideMatrixConstIterator< _elementType >	ThisType
typedef std::random_access_iterator_tag	iterator_category

Public Member Functions
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)
	vctVarStrideMatrixIterator ()
	vctVarStrideMatrixIterator (value_type *dataPtr, stride_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)
value_type &	operator[] (difference_type index) const
value_type &	operator* () const
Public Member Functions inherited from vctVarStrideMatrixConstIterator< _elementType >
	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

Additional Inherited Members
Protected Member Functions inherited from vctVarStrideMatrixConstIterator< _elementType >
void	WrapToRight ()
void	WrapToLeft ()
Protected Attributes inherited from vctVarStrideMatrixConstIterator< _elementType >
value_type *	DataPtr
stride_type	ColumnStride
difference_type	NumColumns
stride_type	RowStride
difference_type	CurrentColumn

Detailed Description

template<class _elementType>
class vctVarStrideMatrixIterator< _elementType >

The non-const iterator with a fixed stride.

See also

vctVarStrideMatrixConstIterator

Member Typedef Documentation

BaseType

template<class _elementType>

typedef vctVarStrideMatrixConstIterator<_elementType> vctVarStrideMatrixIterator< _elementType >::BaseType

iterator_category

template<class _elementType>

typedef BaseType::iterator_category vctVarStrideMatrixIterator< _elementType >::iterator_category

ThisType

template<class _elementType>

typedef vctVarStrideMatrixIterator<_elementType> vctVarStrideMatrixIterator< _elementType >::ThisType

Constructor & Destructor Documentation

vctVarStrideMatrixIterator() [1/2]

template<class _elementType>

vctVarStrideMatrixIterator< _elementType >::vctVarStrideMatrixIterator ( )

inline

Default constructor: create an uninitialized object

vctVarStrideMatrixIterator() [2/2]

template<class _elementType>

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

inline

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

operator*()

template<class _elementType>

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

inline

Add non-const version of unary operator *

operator++() [1/2]

template<class _elementType>

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

inline

Redefine operator++ to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

operator++() [2/2]

template<class _elementType>

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

inline

Redefine operator++ to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

operator+=()

template<class _elementType>

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

inline

Redefine operator+= to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator.

Note

If the number of columns of the matrix is zero then the iterator is returned unchanged.

operator--() [1/2]

template<class _elementType>

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

inline

Redefine operator-- to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

operator--() [2/2]

template<class _elementType>

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

inline

Redefine operator-- to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

operator-=()

template<class _elementType>

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

inline

Redefine operator-= to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

Note

If the number of columns of the matrix is zero then the iterator is returned unchanged.

operator[]()

template<class _elementType>

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

inline

Add non-const version of operator []

VCT_CONTAINER_TRAITS_TYPEDEFS()

template<class _elementType>

vctVarStrideMatrixIterator< _elementType >::VCT_CONTAINER_TRAITS_TYPEDEFS

(

_elementType

)

---

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

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