ERC CISST - cisst software

vctDynamicConstMatrixRef< _elementType > Class Template Reference
[Vectors]

#include <vctDynamicConstMatrixRef.h>

Inheritance diagram for vctDynamicConstMatrixRef< _elementType >:

Inheritance graph
[legend]
Collaboration diagram for vctDynamicConstMatrixRef< _elementType >:

Collaboration graph
[legend]
List of all members.

Detailed Description

template<class _elementType>
class vctDynamicConstMatrixRef< _elementType >

Dynamic matrix referencing existing memory (const).

The class vctDynamicConstMatrixRef allows to create a matrix overlaying an existing block of memory. It can be used to manipulate a container created by another toolkit (i.e. OpenGL, vtk, ...) or a cisstVector container using different parameters (different size, storage order or stride).

To setup the overlay, one can use either the constructors or the SetRef methods. When used with a cisst container, the SetRef methods can infer some of the memory layout information (pointer on first element, sizes, strides). When used to overlay existing memory referenced by a pointer, the user has to provide all the required information. In any case, the Ref object doesn't allocate nor free memory.

Finally, as this overlay is const, it can be used to make sure the referenced content is not modified.

For example to manipulate the first five by five elements of a matrix, one can do: 

  vctDynamicMatrix<double> wholeMatrix(10, 10);
  vctRandom(wholeMatrix, -10.0, 10.0);
  vctDynamicConstMatrixRef<double> first5x5;
  first5x5.SetRef(wholeMatrix, 0, 0, 5, 5);
  std::cout << first5x5 << " " << first5x5.SumOfElements() << std::endl;

Note:
Make sure the underlying memory is not freed after the Ref object is created and before it is used. This would lead to faulty memory access and potential bugs.

vctDynamicConstMatrixRef only performs const operations even if it stores a non-const value_type *. It can be initialized with either value_type * or const value_type *. For a non-const Ref, see vctDynamicMatrixRef.

See also:
vctDynamicMatrix, vctDynamicMatrixRef
Parameters:
_elementType Type of elements referenced. Also defined as value_type.

Definition at line 80 of file vctDynamicConstMatrixRef.h.

Public Types

Public Member Functions

Public Attributes

Member Typedef Documentation

template<class _elementType>
typedef vctDynamicConstMatrixRef<_elementType> vctDynamicConstMatrixRef< _elementType >::ThisType

Type of the matrix itself.

Reimplemented from vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >.

Definition at line 88 of file vctDynamicConstMatrixRef.h.

template<class _elementType>
typedef MatrixOwnerType::iterator vctDynamicConstMatrixRef< _elementType >::iterator

Iterator on the elements of the matrix.

Reimplemented from vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >.

Definition at line 91 of file vctDynamicConstMatrixRef.h.

template<class _elementType>
typedef MatrixOwnerType::const_iterator vctDynamicConstMatrixRef< _elementType >::const_iterator

Const iterator on the elements of the matrix.

Reimplemented from vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >.

Definition at line 92 of file vctDynamicConstMatrixRef.h.

template<class _elementType>
typedef MatrixOwnerType::reverse_iterator vctDynamicConstMatrixRef< _elementType >::reverse_iterator

Reverse iterator on the elements of the matrix.

Reimplemented from vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >.

Definition at line 93 of file vctDynamicConstMatrixRef.h.

template<class _elementType>
typedef MatrixOwnerType::const_reverse_iterator vctDynamicConstMatrixRef< _elementType >::const_reverse_iterator

Const reverse iterator on the elements of the matrix.

Reimplemented from vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >.

Definition at line 94 of file vctDynamicConstMatrixRef.h.

Constructor & Destructor Documentation

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const ThisType &  other  )  [inline]

Copy constructor

Definition at line 102 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Pointer(), vctDynamicConstMatrixRef< _elementType >::SetRef(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::sizes(), and vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::strides().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
stride_type  rowStride,
stride_type  colStride,
pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 113 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
stride_type  rowStride,
stride_type  colStride,
const_pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 119 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
stride_type  rowStride,
stride_type  colStride,
pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 126 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
stride_type  rowStride,
stride_type  colStride,
const_pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 131 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
const nstride_type &  matrixStride,
pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 137 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
const nstride_type &  matrixStride,
const_pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 142 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 155 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
const_pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 160 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 166 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
const_pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 171 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<size_type __rows, size_type __cols, stride_type __rowStride, stride_type __colStride, typename __dataPtrType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const vctFixedSizeConstMatrixBase< __rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType > &  otherMatrix  )  [inline]

Construct a dynamic reference to a fixed-size matrix.

Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors).

Definition at line 185 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<size_type __rows, size_type __cols, stride_type __rowStride, stride_type __colStride, typename __dataPtrType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const vctFixedSizeConstMatrixBase< __rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType > &  otherMatrix,
size_type  startRow,
size_type  startCol,
size_type  rows,
size_type  cols 
) [inline]

Construct a dynamic reference to a submatrix of a fixed-size matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors).

Definition at line 202 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix  )  [inline]

Construct a dynamic reference to a dynamic matrix.

Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other SetRef methods).

Definition at line 214 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix,
size_type  startRow,
size_type  startCol,
size_type  rows,
size_type  cols 
) [inline]

Construct a dynamic reference to a submatrix of a dynamic matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors).

Definition at line 231 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix,
const nsize_type &  start,
const nsize_type &  matrixSize 
) [inline]

Construct a dynamic reference to a submatrix of a dynamic matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors).

Definition at line 238 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
stride_type  rowStride,
stride_type  colStride,
pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 113 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
stride_type  rowStride,
stride_type  colStride,
const_pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 119 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
stride_type  rowStride,
stride_type  colStride,
pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 126 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
stride_type  rowStride,
stride_type  colStride,
const_pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 131 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
const nstride_type &  matrixStride,
pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 137 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
const nstride_type &  matrixStride,
const_pointer  dataPointer 
) [inline]

Constructor requiring the user to provide all the necessary information, i.e. the size (number of rows and columns), the strides (increment from row to row and from column to column) as well as a pointer on the first element.

Definition at line 142 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 155 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( size_type  rows,
size_type  cols,
const_pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 160 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 166 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const nsize_type &  matrixSize,
const_pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Constructor requiring the user to provide the size of the matrix (number of rows and columns), a pointer on the first element and the desired storage order. If the storage order is omitted, the default is used (row major).

Definition at line 171 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix,
size_type  startRow,
size_type  startCol,
size_type  rows,
size_type  cols 
) [inline]

Construct a dynamic reference to a submatrix of a dynamic matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors).

Definition at line 231 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix,
const nsize_type &  start,
const nsize_type &  matrixSize 
) [inline]

Construct a dynamic reference to a submatrix of a dynamic matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other ctors).

Definition at line 238 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

Member Function Documentation

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( size_type  rows,
size_type  cols,
stride_type  rowStride,
stride_type  colStride,
pointer  dataPointer 
) [inline]

Set a dynamic reference to a memory location. The user should specify all the parameters of the referenced memory, including a start memory address.

Definition at line 249 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::OuterProductOf(), vctDynamicConstMatrixRef< _elementType >::SetRef(), and vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( size_type  rows,
size_type  cols,
stride_type  rowStride,
stride_type  colStride,
const_pointer  dataPointer 
) [inline]

Set a dynamic reference to a memory location. The user should specify all the parameters of the referenced memory, including a start memory address.

Definition at line 255 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const nsize_type &  matrixSize,
stride_type  rowStride,
stride_type  colStride,
pointer  dataPointer 
) [inline]

Set a dynamic reference to a memory location. The user should specify all the parameters of the referenced memory, including a start memory address.

Definition at line 262 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const nsize_type &  matrixSize,
stride_type  rowStride,
stride_type  colStride,
const_pointer  dataPointer 
) [inline]

Set a dynamic reference to a memory location. The user should specify all the parameters of the referenced memory, including a start memory address.

Definition at line 267 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const nsize_type &  matrixSize,
const nstride_type &  matrixStride,
pointer  dataPointer 
) [inline]

Set a dynamic reference to a memory location. The user should specify all the parameters of the referenced memory, including a start memory address.

Definition at line 273 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const nsize_type &  matrixSize,
const nstride_type &  matrixStride,
const_pointer  dataPointer 
) [inline]

Set a dynamic reference to a memory location. The user should specify all the parameters of the referenced memory, including a start memory address.

Definition at line 278 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( size_type  rows,
size_type  cols,
pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Set a dynamic reference to a memory location. The user should specify the dimension, start memory address and desired storage order. This method assumes there is enough memory and will create a compact matrix reference.

Definition at line 291 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( size_type  rows,
size_type  cols,
const_pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Set a dynamic reference to a memory location. The user should specify the dimension, start memory address and desired storage order. This method assumes there is enough memory and will create a compact matrix reference.

Definition at line 295 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const nsize_type &  sizes,
pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Set a dynamic reference to a memory location. The user should specify the dimension, start memory address and desired storage order. This method assumes there is enough memory and will create a compact matrix reference.

Definition at line 300 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const nsize_type &  sizes,
const_pointer  dataPointer,
bool  storageOrder = VCT_DEFAULT_STORAGE 
) [inline]

Set a dynamic reference to a memory location. The user should specify the dimension, start memory address and desired storage order. This method assumes there is enough memory and will create a compact matrix reference.

Definition at line 304 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< vctDynamicMatrixRefOwner< _elementType >, _elementType >::Matrix, and vctDynamicMatrixRefOwner< _elementType >::SetRef().

template<class _elementType>
template<size_type __rows, size_type __cols, stride_type __rowStride, stride_type __colStride, typename __dataPtrType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const vctFixedSizeConstMatrixBase< __rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType > &  otherMatrix  )  [inline]

Set a dynamic reference to a fixed-size matrix. The reference will have identical dimensions and strides as the input matrix.

Definition at line 315 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<size_type __rows, size_type __cols, stride_type __rowStride, stride_type __colStride, typename __dataPtrType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const vctFixedSizeConstMatrixBase< __rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType > &  otherMatrix,
size_type  startRow,
size_type  startCol,
size_type  rows,
size_type  cols 
) [inline]

Set a dynamic reference to a submatrix of a fixed-size matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other SetRef methods).

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 336 of file vctDynamicConstMatrixRef.h.

References cmnThrow(), and vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix  )  [inline]

Set a dynamic reference to a dynamic matrix. The reference will have identical dimensions and strides as the input matrix.

Definition at line 350 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::col_stride(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::cols(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Pointer(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::row_stride(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::rows(), and vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix,
size_type  startRow,
size_type  startCol,
size_type  rows,
size_type  cols 
) [inline]

Set a dynamic reference to a submatrix of a dynamic matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other SetRef methods).

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 370 of file vctDynamicConstMatrixRef.h.

References cmnThrow(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::col_stride(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::cols(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Pointer(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::row_stride(), vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::rows(), and vctDynamicConstMatrixRef< _elementType >::SetRef().

template<class _elementType>
template<class __ownerType>
void vctDynamicConstMatrixRef< _elementType >::SetRef ( const vctDynamicConstMatrixBase< __ownerType, _elementType > &  otherMatrix,
const nsize_type &  start,
const nsize_type &  matrixSize 
) [inline]

Set a dynamic reference to a submatrix of a dynamic matrix.

Parameters:
otherMatrix a fixed size matrix to which a reference is created.
startRow row index of the position where the reference will start.
startCol column index of the position where the reference will start.
rows the number of rows being referenced
cols the number of columns being referenced
Note:
the strides of this reference will be identical to the strides of the input matrix. For a more advanced access, customize the parameters yourself (see the other SetRef methods).

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 382 of file vctDynamicConstMatrixRef.h.

References vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Element(), and vctDynamicConstMatrixRef< _elementType >::SetRef().

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