ERC CISST - cisst software

---

vctVarStrideMatrixIterator< _elementType > Class Template Reference

#include <vctVarStrideMatrixIterator.h>

Inheritance diagram for vctVarStrideMatrixIterator< _elementType >:

[legend]Collaboration diagram for vctVarStrideMatrixIterator< _elementType >:

[legend]List of all members.

---

Detailed Description

template<class _elementType>
class vctVarStrideMatrixIterator< _elementType >

The non-const iterator with a fixed stride.

See also:

vctVarStrideMatrixConstIterator

Definition at line 282 of file vctVarStrideMatrixIterator.h.

Public Types

• typedef vctVarStrideMatrixIterator<
  _elementType > ThisType
• typedef vctVarStrideMatrixConstIterator<
  _elementType > BaseType
• typedef BaseType::iterator_category iterator_category

Public Member Functions

• 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 * ()

Public Attributes

• _elementType

---

Member Typedef Documentation

template<class _elementType>

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

The type of the iterator itself.

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 287 of file vctVarStrideMatrixIterator.h.

template<class _elementType>

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

Base type for this iterator, i.e. std::iterator.

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 288 of file vctVarStrideMatrixIterator.h.

template<class _elementType>

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

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

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 289 of file vctVarStrideMatrixIterator.h.

---

Constructor & Destructor Documentation

template<class _elementType>

vctVarStrideMatrixIterator< _elementType >::vctVarStrideMatrixIterator

(

)

[inline]

Default constructor: create an uninitialized object

Definition at line 292 of file vctVarStrideMatrixIterator.h.

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.

Definition at line 300 of file vctVarStrideMatrixIterator.h.

---

Member Function Documentation

template<class _elementType>

ThisType& vctVarStrideMatrixIterator< _elementType >::operator++

(

)

[inline]

Redefine operator++ to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 309 of file vctVarStrideMatrixIterator.h.

References vctVarStrideMatrixConstIterator< _elementType >::ColumnStride, vctVarStrideMatrixConstIterator< _elementType >::CurrentColumn, vctVarStrideMatrixConstIterator< _elementType >::DataPtr, and vctVarStrideMatrixConstIterator< _elementType >::WrapToRight().

template<class _elementType>

ThisType vctVarStrideMatrixIterator< _elementType >::operator++

(

int

)

[inline]

Redefine operator++ to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 319 of file vctVarStrideMatrixIterator.h.

template<class _elementType>

ThisType& vctVarStrideMatrixIterator< _elementType >::operator--

(

)

[inline]

Redefine operator-- to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 328 of file vctVarStrideMatrixIterator.h.

References vctVarStrideMatrixConstIterator< _elementType >::ColumnStride, vctVarStrideMatrixConstIterator< _elementType >::CurrentColumn, vctVarStrideMatrixConstIterator< _elementType >::DataPtr, and vctVarStrideMatrixConstIterator< _elementType >::WrapToLeft().

template<class _elementType>

ThisType vctVarStrideMatrixIterator< _elementType >::operator--

(

int

)

[inline]

Redefine operator-- to return vctVarStrideMatrixIterator instead of vctVarStrideMatrixConstIterator

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 338 of file vctVarStrideMatrixIterator.h.

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.

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 350 of file vctVarStrideMatrixIterator.h.

References vctVarStrideMatrixConstIterator< _elementType >::ColumnStride, vctVarStrideMatrixConstIterator< _elementType >::CurrentColumn, vctVarStrideMatrixConstIterator< _elementType >::DataPtr, vctVarStrideMatrixConstIterator< _elementType >::NumColumns, vctVarStrideMatrixConstIterator< _elementType >::WrapToLeft(), and vctVarStrideMatrixConstIterator< _elementType >::WrapToRight().

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.

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 368 of file vctVarStrideMatrixIterator.h.

References vctVarStrideMatrixConstIterator< _elementType >::ColumnStride, vctVarStrideMatrixConstIterator< _elementType >::CurrentColumn, vctVarStrideMatrixConstIterator< _elementType >::DataPtr, vctVarStrideMatrixConstIterator< _elementType >::NumColumns, vctVarStrideMatrixConstIterator< _elementType >::WrapToLeft(), and vctVarStrideMatrixConstIterator< _elementType >::WrapToRight().

template<class _elementType>

value_type& vctVarStrideMatrixIterator< _elementType >::operator[]

(

difference_type

index

)

const [inline]

Add non-const version of operator []

Reimplemented from vctVarStrideMatrixConstIterator< _elementType >.

Definition at line 382 of file vctVarStrideMatrixIterator.h.

template<class _elementType>

value_type& vctVarStrideMatrixIterator< _elementType >::operator *

(

)

[inline]

Add non-const version of unary operator *

Definition at line 390 of file vctVarStrideMatrixIterator.h.

References vctVarStrideMatrixConstIterator< _elementType >::DataPtr.

---

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

• vctVarStrideMatrixIterator.h

---