vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride > Class Template Reference

Define common container related types based on the properties of a fixed size container. More...

#include <vctFixedSizeMatrixTraits.h>

Public Types
enum	{ ROWS = _rows , COLS = _cols , LENGTH = ROWS*COLS }
enum	{ ROWSTRIDE = _rowStride , COLSTRIDE = _colStride }
typedef vctFixedStrideMatrixIterator< _elementType, _colStride, _cols, _rowStride >	iterator
typedef vctFixedStrideMatrixConstIterator< _elementType, _colStride, _cols, _rowStride >	const_iterator
typedef vctFixedStrideMatrixIterator< _elementType, -_colStride, _cols, -_rowStride >	reverse_iterator
typedef vctFixedStrideMatrixConstIterator< _elementType, -_colStride, _cols, -_rowStride >	const_reverse_iterator
typedef value_type	array[LENGTH]
typedef const value_type	const_array[LENGTH]

Public Member Functions
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)

Detailed Description

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
class vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >

Define common container related types based on the properties of a fixed size container.

The types are declared according to the STL requirements for the types declared by a container object. This class is used as a trait to declare the actual containers.

In addition to the STL required types, we declare a few more types for completeness.

Member Typedef Documentation

array

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef value_type vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::array[LENGTH]

Declared for completeness.

const_array

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef const value_type vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::const_array[LENGTH]

Declared for completeness.

const_iterator

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef vctFixedStrideMatrixConstIterator<_elementType, _colStride, _cols, _rowStride> vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::const_iterator

Const iterator, follows the STL naming convention.

const_reverse_iterator

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef vctFixedStrideMatrixConstIterator<_elementType, -_colStride, _cols, -_rowStride> vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::const_reverse_iterator

Const reverse iterator, follows the STL naming convention.

iterator

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef vctFixedStrideMatrixIterator<_elementType, _colStride, _cols, _rowStride> vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::iterator

Iterator, follows the STL naming convention.

reverse_iterator

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

typedef vctFixedStrideMatrixIterator<_elementType, -_colStride, _cols, -_rowStride> vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::reverse_iterator

Reverse iterator, follows the STL naming convention.

Member Enumeration Documentation

anonymous enum

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

anonymous enum

Define the dimensions of the matrix: number of rows, number of columns, and the total length of the matrix, which is their product

Enumerator
ROWS
COLS
LENGTH

anonymous enum

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

anonymous enum

Declared to enable inference of the stride of the container.

Enumerator
ROWSTRIDE
COLSTRIDE

Member Function Documentation

VCT_CONTAINER_TRAITS_TYPEDEFS()

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>

vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::VCT_CONTAINER_TRAITS_TYPEDEFS

(

_elementType

)

---

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

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