ERC CISST - cisst software

vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride > Class Template Reference
[Vectors]

#include <vctFixedSizeMatrixRef.h>

Inheritance diagram for vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >:

Inheritance graph
[legend]
Collaboration diagram for vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >:

Collaboration graph
[legend]
List of all members.

Detailed Description

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

An implementation of the ``abstract'' vctFixedSizeMatrixBase.

This implementations uses a pointer to the matrix beginning as the matrix defining data member. An instantiation of this type can be used as a matrix reference with TransposeRef().

See the base class (vctFixedSizeMatrixBase) for template parameter details.

See also:
vctFixedSizeConstMatrixRef

Definition at line 49 of file vctFixedSizeMatrixRef.h.

Public Types

Public Member Functions

Assignment operation into a matrix reference
Parameters:
other The matrix to be copied.


Public Attributes

Member Typedef Documentation

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

Traits used for all useful types related to a vctFixedSizeMatrix

Reimplemented from vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::pointer >.

Definition at line 58 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
typedef MatrixTraits::iterator vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::iterator

Iterator on the elements of the matrix.

Reimplemented from vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::pointer >.

Definition at line 60 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
typedef MatrixTraits::const_iterator vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::const_iterator

Const iterator on the elements of the matrix.

Reimplemented from vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::pointer >.

Definition at line 61 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
typedef MatrixTraits::reverse_iterator vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::reverse_iterator

Reverse iterator on the elements of the matrix.

Reimplemented from vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::pointer >.

Definition at line 62 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
typedef MatrixTraits::const_reverse_iterator vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::const_reverse_iterator

Const reverse iterator on the elements of the matrix.

Reimplemented from vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::pointer >.

Definition at line 63 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
typedef vctFixedSizeMatrixRef<value_type, _rows, _cols, _rowStride, _colStride> vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::ThisType

Type of the matrix itself.

Reimplemented from vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::pointer >.

Reimplemented in vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >, vctMatrixRotation3Base< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >, and vctMatrixRotation3ConstBase< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >.

Definition at line 66 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
typedef vctFixedSizeMatrixBase<_rows, _cols, _rowStride, _colStride, value_type, typename MatrixTraits::pointer> vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::BaseType

Type of the base class.

Reimplemented from vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >::pointer >.

Reimplemented in vctMatrixRotation3Ref< _elementType, _rowStride, _colStride >, vctMatrixRotation3Base< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >, and vctMatrixRotation3ConstBase< vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride > >.

Definition at line 68 of file vctFixedSizeMatrixRef.h.

Constructor & Destructor Documentation

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::vctFixedSizeMatrixRef (  )  [inline]

Default constructor: create an uninitialized matrix

Definition at line 71 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::vctFixedSizeMatrixRef ( pointer  p  )  [inline]

Initialize the matrix with a (non-const) pointer

Definition at line 75 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
template<size_type __rows, size_type __cols, class __dataPtrType>
vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::vctFixedSizeMatrixRef ( vctFixedSizeMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > &  matrix  )  [inline, explicit]

Convenience constructor to initialize a reference to a fixed-size matrix object. The constructor is declared as explicit, and care must be taken when a matrix object is passed as a function argument.

Definition at line 84 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
template<size_type __rows, size_type __cols, class __dataPtrType>
vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::vctFixedSizeMatrixRef ( vctFixedSizeMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > &  matrix,
index_type  startRow,
index_type  startCol 
) [inline]

Convenience constructor to initialize a reference to a fixed-size matrix object.

Definition at line 93 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
template<class __matrixOwnerType>
vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::vctFixedSizeMatrixRef ( vctDynamicMatrixBase< __matrixOwnerType, _elementType > &  matrix,
index_type  startRow,
index_type  startCol 
) [inline]

Convenience constructor to initialize a fixed-size reference to a dynamic matrix. The constructor involves assertion that the sizes and strides match

Definition at line 104 of file vctFixedSizeMatrixRef.h.

Member Function Documentation

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
void vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::SetRef ( pointer  p  )  [inline]

Assign the matrix start with a (non-const) pointer

Definition at line 111 of file vctFixedSizeMatrixRef.h.

Referenced by vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride >::SetRef(), and vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride >::vctFixedSizeMatrixRef().

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
template<size_type __rows, size_type __cols, class __dataPtrType>
void vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::SetRef ( vctFixedSizeMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > &  matrix,
index_type  startRow,
index_type  startCol 
) [inline]

Convenience method to set a reference to a fixed-size matrix object.

Parameters:
matrix the fixed size matrix to be referenced
startRow the row index from which reference will start
startCol the column index from which reference will start The strides of this matrix must be identical to the strides of the other matrix (this is enforced by the template parameters).
Note:
This method verifies that the size of this matrix does not exceed the size of the input matrix (otherwise cmnThrow is used to throw std::out_of_range).

Definition at line 129 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
template<class __matrixOwnerType>
void vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::SetRef ( vctDynamicMatrixBase< __matrixOwnerType, _elementType > &  matrix,
index_type  startRow,
index_type  startCol 
) [inline]

Convenience method to set a reference to a dynamic matrix object.

Parameters:
matrix the fixed size matrix to be referenced
startRow the row index from which reference will start
startCol the column index from which reference will start The strides of this matrix must be identical to the strides of the other matrix (otherwise cmnThrow is used to throw std::runtime_error).
Note:
This method verifies that the size of this matrix does not exceed the size of the input matrix (otherwise cmnThrow is used to throw std::out_of_range).

Definition at line 154 of file vctFixedSizeMatrixRef.h.

template<class _elementType, vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride>
ThisType& vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride >::operator= ( const value_type &  value  )  [inline]

Assignement of a scalar to all elements. See also SetAll.

Definition at line 188 of file vctFixedSizeMatrixRef.h.

The documentation for this class was generated from the following file:
erc-cisst-devel<at>lists.johnshopkins.edu