vctFixedSizeConstMatrixRef.h File Reference

Declaration of vctFixedSizeConstMatrixRef. More...

#include <cisstVector/vctFixedSizeMatrixBase.h>

Go to the source code of this file.

Macros
#define	_vctFixedSizeConstMatrixRef_h

Typedefs
typedef vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowStride, _colStride >	MatrixTraits
typedef MatrixTraits::iterator	iterator
typedef MatrixTraits::const_iterator	const_iterator
typedef MatrixTraits::reverse_iterator	reverse_iterator
typedef MatrixTraits::const_reverse_iterator	const_reverse_iterator
typedef vctFixedSizeConstMatrixRef< value_type, _rows, _cols, _rowStride, _colStride >	ThisType
typedef vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, value_type, typename MatrixTraits::pointer >	BaseType

Functions
	VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)
	An nArray object of dynamic size.
	vctFixedSizeConstMatrixRef ()
	vctFixedSizeConstMatrixRef (pointer p)
template<size_type __rows, size_type __cols, class __dataPtrType>
	vctFixedSizeConstMatrixRef (const vctFixedSizeConstMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > &matrix)
template<size_type __rows, size_type __cols, class __dataPtrType>
	vctFixedSizeConstMatrixRef (const vctFixedSizeConstMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > &matrix, size_type startRow, size_type startCol)
template<class __matrixOwnerType>
	vctFixedSizeConstMatrixRef (const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > &matrix, size_type startRow, size_type startCol)
	vctFixedSizeConstMatrixRef (const_pointer p)
void	SetRef (pointer p)
void	SetRef (const_pointer p)
template<size_type __rows, size_type __cols, class __dataPtrType>
void	SetRef (const vctFixedSizeConstMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > &matrix, size_type startRow, size_type startCol)
template<class __matrixOwnerType>
void	SetRef (const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > &matrix, size_type startRow, size_type startCol)

Detailed Description

Declaration of vctFixedSizeConstMatrixRef.

Macro Definition Documentation

_vctFixedSizeConstMatrixRef_h

#define _vctFixedSizeConstMatrixRef_h

Typedef Documentation

BaseType

typedef vctFixedSizeConstMatrixBase<_rows, _cols, _rowStride, _colStride, value_type, typename MatrixTraits::pointer> BaseType

const_iterator

typedef MatrixTraits::const_iterator const_iterator

const_reverse_iterator

typedef MatrixTraits::const_reverse_iterator const_reverse_iterator

iterator

typedef MatrixTraits::iterator iterator

MatrixTraits

typedef vctFixedSizeMatrixTraits<_elementType, _rows, _cols, _rowStride, _colStride> MatrixTraits

reverse_iterator

typedef MatrixTraits::reverse_iterator reverse_iterator

ThisType

typedef vctFixedSizeConstMatrixRef<value_type, _rows, _cols, _rowStride, _colStride> ThisType

Function Documentation

SetRef() [1/4]

template<class __matrixOwnerType>

void SetRef ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & matrix, size_type startRow, size_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 asserts 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).

SetRef() [2/4]

template<size_type __rows, size_type __cols, class __dataPtrType>

void SetRef ( const vctFixedSizeConstMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > & matrix, size_type startRow, size_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 asserts 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).

SetRef() [3/4]

void SetRef ( const_pointer p )

inline

Assign the matrix start with a const pointer. This requires const_cast.

SetRef() [4/4]

void SetRef ( pointer p )

inline

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

vctFixedSizeConstMatrixRef() [1/6]

vctFixedSizeConstMatrixRef ( )

inline

Default constructor: create an uninitialized matrix

vctFixedSizeConstMatrixRef() [2/6]

template<class __matrixOwnerType>

vctFixedSizeConstMatrixRef ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & matrix, size_type startRow, size_type startCol )

inline

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

vctFixedSizeConstMatrixRef() [3/6]

template<size_type __rows, size_type __cols, class __dataPtrType>

vctFixedSizeConstMatrixRef ( const vctFixedSizeConstMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > & matrix )

inline

Convenience constructor to initialize a reference to a fixed-size matrix object. Since the argument is const, there is no worry about explicit instantiation.

vctFixedSizeConstMatrixRef() [4/6]

template<size_type __rows, size_type __cols, class __dataPtrType>

vctFixedSizeConstMatrixRef ( const vctFixedSizeConstMatrixBase< __rows, __cols, _rowStride, _colStride, _elementType, __dataPtrType > & matrix, size_type startRow, size_type startCol )

inline

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

vctFixedSizeConstMatrixRef() [5/6]

vctFixedSizeConstMatrixRef ( const_pointer p )

inline

Initialize the matrix with a const pointer. This requires const_cast.

vctFixedSizeConstMatrixRef() [6/6]

vctFixedSizeConstMatrixRef ( pointer p )

inline

Initialize the matrix with a (non-const) pointer