cisst-saw
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType > Class Template Reference

A template for a fixed size matrix with fixed spacings in memory. More...

#include <vctFixedSizeMatrixBase.h>

Inheritance diagram for vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >:
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType > vctFixedSizeMatrix< bool, ROWS, COLS, COLSTRIDE<=ROWSTRIDE > vctFixedSizeMatrix< float, 1, 1 > vctFixedSizeMatrix< float, 1, 2 > vctFixedSizeMatrix< float, 1, 3 > vctFixedSizeMatrix< float, 1, 4 > vctFixedSizeMatrix< float, 2, 1 > vctFixedSizeMatrix< float, 2, 2 > vctFixedSizeMatrix< float, 2, 3 > vctFixedSizeMatrix< float, 2, 4 > vctFixedSizeMatrix< float, 3, 1 > vctFixedSizeMatrix< float, 3, 2 > vctFixedSizeMatrix< float, 3, 3 > vctFixedSizeMatrix< float, 3, 4 > vctFixedSizeMatrix< float, 4, 1 > vctFixedSizeMatrix< float, 4, 2 > vctFixedSizeMatrix< float, 4, 3 > vctFixedSizeMatrix< float, 4, 4 > vctFixedSizeMatrix< int, 1, 1 > vctFixedSizeMatrix< int, 1, 2 > vctFixedSizeMatrix< int, 1, 3 > vctFixedSizeMatrix< int, 1, 4 > vctFixedSizeMatrix< int, 2, 1 > vctFixedSizeMatrix< int, 2, 2 > vctFixedSizeMatrix< int, 2, 3 > vctFixedSizeMatrix< int, 2, 4 > vctFixedSizeMatrix< int, 3, 1 > vctFixedSizeMatrix< int, 3, 2 > vctFixedSizeMatrix< int, 3, 3 > vctFixedSizeMatrix< int, 3, 4 > vctFixedSizeMatrix< int, 4, 1 > vctFixedSizeMatrix< int, 4, 2 > vctFixedSizeMatrix< int, 4, 3 > vctFixedSizeMatrix< int, 4, 4 > vctFixedSizeMatrix< char, 1, 1 > vctFixedSizeMatrix< char, 2, 2 > vctFixedSizeMatrix< char, 3, 3 > vctFixedSizeMatrix< char, 4, 4 > vctFixedSizeMatrix< value_type, ROWS, COLS, _rowMajor > vctFixedSizeMatrix< value_type, ROWS, COLS >

Classes

class  Submatrix

Public Types

enum  { ROWS = MatrixTraits::ROWS , COLS = MatrixTraits::COLS , LENGTH = MatrixTraits::LENGTH }
enum  { ROWSTRIDE = MatrixTraits::ROWSTRIDE , COLSTRIDE = MatrixTraits::COLSTRIDE }
typedef vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType > ThisType
typedef vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType > BaseType
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 BaseType::RowRefType RowRefType
typedef BaseType::ColumnRefType ColumnRefType
typedef BaseType::ConstRowRefType ConstRowRefType
typedef BaseType::ConstColumnRefType ConstColumnRefType
typedef BaseType::DiagonalRefType DiagonalRefType
typedef BaseType::ConstDiagonalRefType ConstDiagonalRefType
typedef BaseType::RefTransposeType RefTransposeType
typedef BaseType::ConstRefTransposeType ConstRefTransposeType
typedef BaseType::RowValueType RowValueType
typedef BaseType::ColumnValueType ColumnValueType
Public Types inherited from vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >
enum  { DIMENSION = 2 }
enum  { ROWS = MatrixTraits::ROWS , COLS = MatrixTraits::COLS , LENGTH = MatrixTraits::LENGTH }
enum  { ROWSTRIDE = MatrixTraits::ROWSTRIDE , COLSTRIDE = MatrixTraits::COLSTRIDE }
enum  { DIAGONAL_LENGTH = (ROWS <= COLS) ? ROWS : COLS , DIAGONAL_STRIDE = ROWSTRIDE + COLSTRIDE }
typedef vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType > ThisType
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 vctFixedSizeConstVectorRef< _elementType, COLS, COLSTRIDE > ConstRowRefType
typedef vctFixedSizeVectorRef< _elementType, COLS, COLSTRIDE > RowRefType
typedef vctFixedSizeConstVectorRef< _elementType, ROWS, ROWSTRIDE > ConstColumnRefType
typedef vctFixedSizeVectorRef< _elementType, ROWS, ROWSTRIDE > ColumnRefType
typedef vctFixedSizeConstVectorRef< _elementType, DIAGONAL_LENGTH, DIAGONAL_STRIDE > ConstDiagonalRefType
typedef vctFixedSizeVectorRef< _elementType, DIAGONAL_LENGTH, DIAGONAL_STRIDE > DiagonalRefType
typedef vctFixedSizeVector< _elementType, COLS > RowValueType
typedef vctFixedSizeVector< _elementType, ROWS > ColumnValueType
typedef vctFixedSizeConstMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride > ConstRefType
typedef vctFixedSizeMatrixRef< _elementType, _rows, _cols, _rowStride, _colStride > RefType
typedef vctFixedSizeConstMatrixRef< _elementType, _cols, _rows, _colStride, _rowStride > ConstRefTransposeType
typedef vctFixedSizeMatrixRef< _elementType, _cols, _rows, _colStride, _rowStride > RefTransposeType
typedef vctFixedSizeMatrix< _elementType, COLS, ROWS, COLSTRIDE<=ROWSTRIDE > TransposeValueType
typedef vctFixedSizeMatrix< _elementType, ROWS, COLS, COLSTRIDE<=ROWSTRIDE > MatrixValueType
typedef vctFixedSizeMatrix< bool, ROWS, COLS, COLSTRIDE<=ROWSTRIDE > BoolMatrixValueType
typedef _dataPtrType DataType

Public Member Functions

 VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)
iterator begin ()
const_iterator begin () const
iterator end ()
const_iterator end () const
reverse_iterator rbegin ()
const_reverse_iterator rbegin () const
reverse_iterator rend ()
const_reverse_iterator rend () const
RowRefType operator[] (size_type index)
ConstRowRefType operator[] (size_type index) const
pointer Pointer (size_type rowIndex, size_type colIndex)
pointer Pointer (void)
const_pointer Pointer (size_type rowIndex, size_type colIndex) const
const_pointer Pointer (void) const
reference at (size_type index) CISST_THROW(std
const_reference at (size_type index) const CISST_THROW(std
reference at (size_type rowIndex, size_type colIndex) CISST_THROW(std
const_reference at (size_type rowIndex, size_type colIndex) const CISST_THROW(std
reference operator() (size_type rowIndex, size_type colIndex) CISST_THROW(std
const_reference operator() (size_type rowIndex, size_type colIndex) const CISST_THROW(std
reference Element (size_type rowIndex, size_type colIndex)
const_reference Element (size_type rowIndex, size_type colIndex) const
Row, column, and main diagonal references.
RowRefType Row (size_type index)
ColumnRefType Column (size_type index)
DiagonalRefType Diagonal (void)
ConstRowRefType Row (size_type index) const
ConstColumnRefType Column (size_type index) const
ConstDiagonalRefType Diagonal (void) const
template<vct::size_type __subRows, vct::size_type __subCols>
vctFixedSizeMatrixRef< _elementType, __subRows, __subCols, _rowStride, _colStride > Ref (const size_type startRow=0, const size_type startCol=0) CISST_THROW(std
template<vct::size_type __subRows, vct::size_type __subCols>
vctFixedSizeConstMatrixRef< _elementType, __subRows, __subCols, _rowStride, _colStride > Ref (const size_type startRow=0, const size_type startCol=0) const CISST_THROW(std
void ExchangeRows (const size_type row1Index, const size_type row2Index)
void ExchangeColumns (const size_type col1Index, const size_type col2Index)
template<size_type __rows, stride_type __rowStride, stride_type __colStride, class __dataPtrType, stride_type __indexStride, class __indexDataPtrType>
void SelectRowsFrom (const vctFixedSizeConstMatrixBase< __rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > &inputMatrix, const vctFixedSizeConstVectorBase< _rows, __indexStride, index_type, __indexDataPtrType > &rowIndexVector)
template<size_type __cols, stride_type __rowStride, stride_type __colStride, class __dataPtrType, stride_type __indexStride, class __indexDataPtrType>
void SelectColsFrom (const vctFixedSizeConstMatrixBase< _rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType > &inputMatrix, const vctFixedSizeConstVectorBase< _cols, __indexStride, index_type, __indexDataPtrType > &colIndexVector)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void RowPermutationOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > &inputMatrix, const index_type permutedRowIndexes[])
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void RowInversePermutationOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > &inputMatrix, const index_type permutedRowIndexes[])
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void ColumnPermutationOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > &inputMatrix, const index_type permutedColumnIndexes[])
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void ColumnInversePermutationOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > &inputMatrix, const index_type permutedColumnIndexes[])
value_type SetAll (const value_type value)
bool Zeros (void)
template<stride_type __rowStride, stride_type __colStride, class __elementType, class __dataPtrType>
ThisType & Assign (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, __elementType, __dataPtrType > &other)
ThisType & Assign (const value_type *elements, bool inputIsRowMajor=true)
template<class __matrixOwnerType>
ThisType & Assign (const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > &other)
Forced assignment operation between matrices of

different types. On fixed size matrices this method is equivalent to Assign. See notes below!

Note
For a non-reallocating Assign, it is recommended to use the Assign() methods.
This method is provided for both fixed size and dynamic matrices for API consistency (usable in templated code). There is obviously not resize involved on fixed size matrices.
If the destination matrix doesn't have the same size as the source and can not be resized, an exception will be thrown by the Assign method called internally.
Parameters
otherThe matrix to be copied.
template<stride_type __rowStride, stride_type __colStride, class __elementType, class __dataPtrType>
ThisType & ForceAssign (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, __elementType, __dataPtrType > &other)
template<class __matrixOwnerType>
ThisType & ForceAssign (const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > &other)
template<class __matrixOwnerType>
bool FastCopyOf (const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > &source, bool performSafetyChecks=vctFastCopy::PerformChecks) CISST_THROW(std
template<class __dataPtrType>
bool FastCopyOf (const vctFixedSizeConstMatrixBase< ROWS, COLS, ROWSTRIDE, COLSTRIDE, value_type, __dataPtrType > &source, bool performSafetyChecks=vctFastCopy::PerformChecks) CISST_THROW(std
RefTransposeType TransposeRef (void)
ConstRefTransposeType TransposeRef (void) const
Binary elementwise operations between two matrices.

Store the result of op(this, otherMatrix) back to this matrix.

template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & SumOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > &input1Matrix, const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > &input2Matrix)
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & DifferenceOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > &input1Matrix, const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > &input2Matrix)
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & ElementwiseProductOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > &input1Matrix, const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > &input2Matrix)
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & ElementwiseRatioOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > &input1Matrix, const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > &input2Matrix)
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & ElementwiseMinOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > &input1Matrix, const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > &input2Matrix)
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & ElementwiseMaxOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > &input1Matrix, const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > &input2Matrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & Add (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & Subtract (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ElementwiseMultiply (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ElementwiseDivide (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ElementwiseMin (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ElementwiseMax (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & operator+= (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & operator-= (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
Binary elementwise operations a matrix and a scalar.

Store the result of op(matrix, scalar) to a third matrix.

template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & SumOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix, const value_type scalar)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & DifferenceOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix, const value_type scalar)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ProductOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix, const value_type scalar)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & RatioOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix, const value_type scalar)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ClippedAboveOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix, const value_type upperBound)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ClippedBelowOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix, const value_type lowerBound)
Binary elementwise operations a scalar and a matrix.

Store the result of op(scalar, matrix) to a third matrix.

template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & SumOf (const value_type scalar, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & DifferenceOf (const value_type scalar, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ProductOf (const value_type scalar, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & RatioOf (const value_type scalar, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ClippedAboveOf (const value_type upperBound, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & ClippedBelowOf (const value_type lowerBound, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &matrix)
Binary elementwise operations between a matrix and a scalar.

Store the result of op(this, scalar) back to this matrix.

ThisType & Add (const value_type scalar)
ThisType & Subtract (const value_type scalar)
ThisType & Multiply (const value_type scalar)
ThisType & Divide (const value_type scalar)
ThisType & ClipAbove (const value_type upperBound)
ThisType & ClipBelow (const value_type lowerBound)
ThisType & operator+= (const value_type scalar)
ThisType & operator-= (const value_type scalar)
ThisType & operator*= (const value_type scalar)
ThisType & operator/= (const value_type scalar)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & AddProductOf (const value_type scalar, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride1, stride_type __colStride1, class __dataPtrType1, stride_type __rowStride2, stride_type __colStride2, class __dataPtrType2>
ThisType & AddElementwiseProductOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride1, __colStride1, value_type, __dataPtrType1 > &matrix1, const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride2, __colStride2, value_type, __dataPtrType2 > &matrix2)
Unary elementwise operations.

Store the result of op(matrix) to another matrix.

template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & AbsOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & NegationOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & FloorOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & CeilOf (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & TransposeOf (const vctFixedSizeConstMatrixBase< _cols, _rows, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix)
Store back unary elementwise operations.

Store the result of op(this) to this matrix.

ThisType & AbsSelf (void)
ThisType & NegationSelf (void)
ThisType & FloorSelf (void)
ThisType & CeilSelf (void)
template<size_type __input1Cols, stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
void ProductOf (const vctFixedSizeConstMatrixBase< _rows, __input1Cols, __input1RowStride, __input1ColStride, _elementType, __input1DataPtrType > &input1Matrix, const vctFixedSizeConstMatrixBase< __input1Cols, _cols, __input2RowStride, __input2ColStride, _elementType, __input2DataPtrType > &input2Matrix)
template<stride_type __stride1, class __dataPtrType1, stride_type __stride2, class __dataPtrType2>
void OuterProductOf (const vctFixedSizeConstVectorBase< _rows, __stride1, _elementType, __dataPtrType1 > &columnVector, const vctFixedSizeConstVectorBase< _cols, __stride2, _elementType, __dataPtrType2 > &rowVector)
bool FromStreamRaw (std::istream &inputStream, const char delimiter=' ')
void DeSerializeRaw (std::istream &inputStream)
Public Member Functions inherited from vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >
 VCT_CONTAINER_TRAITS_TYPEDEFS (_elementType)
 VCT_NARRAY_TRAITS_TYPEDEFS (DIMENSION)
const_iterator begin () const
const_iterator end () const
const_reverse_iterator rbegin () const
const_reverse_iterator rend () const
size_type size () const
const nsize_type & sizes (void) const
size_type rows () const
size_type cols () const
size_type max_size () const
const nstride_type & strides (void) const
difference_type row_stride () const
difference_type col_stride () const
bool empty () const
ConstRowRefType operator[] (size_type index) const
const_pointer Pointer (size_type rowIndex, size_type colIndex) const
const_pointer Pointer (void) const
bool ValidIndex (size_type index) const
bool ValidIndex (size_type rowIndex, size_type colIndex) const
bool ValidRowIndex (size_type rowIndex) const
bool ValidColIndex (size_type colIndex) const
const_reference at (size_type index) const CISST_THROW(std
const_reference at (size_type rowIndex, size_type colIndex) const CISST_THROW(std
const_reference operator() (size_type rowIndex, size_type colIndex) const CISST_THROW(std
const_reference Element (size_type rowIndex, size_type colIndex) const
ConstRowRefType Row (size_type index) const
ConstColumnRefType Column (size_type index) const
ConstDiagonalRefType Diagonal (void) const
template<vct::size_type __subRows, vct::size_type __subCols>
vctFixedSizeConstMatrixRef< _elementType, __subRows, __subCols, _rowStride, _colStride > Ref (const size_type startRow=0, const size_type startCol=0) const CISST_THROW(std
value_type SumOfElements () const
value_type ProductOfElements () const
value_type Trace (void) const
value_type NormSquare (void) const
NormType Norm (void) const
value_type L1Norm (void) const
value_type LinfNorm (void) const
value_type MaxElement (void) const
value_type MinElement (void) const
value_type MaxAbsElement (void) const
value_type MinAbsElement (void) const
void MinAndMaxElement (value_type &minElement, value_type &maxElement) const
bool IsPositive (void) const
bool IsNonNegative (void) const
bool IsNonPositive (void) const
bool IsNegative (void) const
bool All (void) const
bool Any (void) const
bool IsFinite (void) const
bool HasNaN (void) const
bool IsColMajor (void) const
bool IsRowMajor (void) const
bool IsCompact (void) const
bool IsFortran (void) const
bool StorageOrder (void) const
bool IsSquare (void) const
bool IsSquare (size_type size) const
template<size_type __rows, size_type __cols, stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool FastCopyCompatible (const vctFixedSizeConstMatrixBase< __rows, __cols, __rowStride, __colStride, value_type, __dataPtrType > &source) const
template<class __matrixOwnerType>
bool FastCopyCompatible (const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > &source) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool Equal (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool operator== (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool AlmostEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix, value_type tolerance) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool AlmostEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool NotEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool operator!= (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool Lesser (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool LesserOrEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool Greater (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool GreaterOrEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
BoolMatrixValueType ElementwiseEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
BoolMatrixValueType ElementwiseNotEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
BoolMatrixValueType ElementwiseLesser (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
BoolMatrixValueType ElementwiseLesserOrEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
BoolMatrixValueType ElementwiseGreater (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
BoolMatrixValueType ElementwiseGreaterOrEqual (const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > &otherMatrix) const
bool Equal (const value_type &scalar) const
bool operator== (const value_type &scalar) const
bool NotEqual (const value_type &scalar) const
bool operator!= (const value_type &scalar) const
bool Lesser (const value_type &scalar) const
bool LesserOrEqual (const value_type &scalar) const
bool Greater (const value_type &scalar) const
bool GreaterOrEqual (const value_type &scalar) const
BoolMatrixValueType ElementwiseEqual (const value_type &scalar) const
BoolMatrixValueType ElementwiseNotEqual (const value_type &scalar) const
BoolMatrixValueType ElementwiseLesser (const value_type &scalar) const
BoolMatrixValueType ElementwiseLesserOrEqual (const value_type &scalar) const
BoolMatrixValueType ElementwiseGreater (const value_type &scalar) const
BoolMatrixValueType ElementwiseGreaterOrEqual (const value_type &scalar) const
MatrixValueType Abs (void) const
MatrixValueType Negation (void) const
MatrixValueType Floor (void) const
MatrixValueType Ceil (void) const
ConstRefTransposeType TransposeRef (void) const
TransposeValueType Transpose () const
std::string ToString (void) const
void ToStream (std::ostream &outputStream) const
void ToStreamRaw (std::ostream &outputStream, const char delimiter=' ', bool headerOnly=false, const std::string &headerPrefix="") const
void SerializeRaw (std::ostream &outputStream) const

Additional Inherited Members

static const MatrixValueType & Eye (void)
Protected Member Functions inherited from vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >
void ThrowUnlessValidIndex (size_type index) const CISST_THROW(std
void ThrowUnlessValidIndex (size_type rowIndex, size_type colIndex) const CISST_THROW(std
Protected Attributes inherited from vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >
DataType Data

Detailed Description

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

A template for a fixed size matrix with fixed spacings in memory.

This class defines a matrix with read/write operations. It extends vctFixedSizeConstMatrixBase with non-const methods. See the base class for more documentation.

See also
vctFixedSizeConstMatrixBase

Member Typedef Documentation

◆ BaseType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeConstMatrixBase<_rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType> vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::BaseType

Type of the base class.

◆ ColumnRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::ColumnRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ColumnRefType

◆ ColumnValueType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::ColumnValueType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ColumnValueType

◆ const_iterator

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

◆ const_reverse_iterator

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

◆ ConstColumnRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::ConstColumnRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ConstColumnRefType

◆ ConstDiagonalRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::ConstDiagonalRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ConstDiagonalRefType

◆ ConstRefTransposeType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::ConstRefTransposeType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ConstRefTransposeType

◆ ConstRowRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::ConstRowRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ConstRowRefType

◆ DiagonalRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::DiagonalRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::DiagonalRefType

◆ iterator

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

◆ MatrixTraits

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

◆ RefTransposeType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::RefTransposeType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RefTransposeType

◆ reverse_iterator

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

◆ RowRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::RowRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RowRefType

◆ RowValueType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef BaseType::RowValueType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RowValueType

◆ ThisType

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

Member Enumeration Documentation

◆ anonymous enum

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

Define the strides between rows and columns of the matrix

Enumerator
ROWSTRIDE 
COLSTRIDE 

◆ anonymous enum

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

Define the dimensions of the matrix

Enumerator
ROWS 
COLS 
LENGTH 

Member Function Documentation

◆ AbsOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::AbsOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

Unary elementwise operations on a matrix. For each element of the matrix "this", performs \( this[i] \leftarrow op(otherMatrix[i])\) where \(op\) can calculate the absolute value (AbsOf), the opposite (NegationOf) or the transpose (TransposeOf).

Parameters
otherMatrixThe operand of the unary operation.
Returns
The matrix "this" modified.

◆ AbsSelf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::AbsSelf ( void )
inline

Unary elementwise operations on a matrix. For each element of the matrix "this", performs \( this[i] \leftarrow op(this[i])\) where \(op\) can calculate the absolute value (AbsSelf) or the opposite (NegationSelf).

Returns
The matrix "this" modified.

◆ Add() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Add ( const value_type scalar)
inline

Store back binary elementwise operations between a matrix and a scalar. For each element of the matrix "this", performs \(this[i] \leftarrow op(this[i], scalar)\) where \(op\) is either an addition (Add), a subtraction (Subtract), a multiplication (Multiply), a division (Divide), a minimum (ClipAbove) or a maximum (ClipBelow).

Parameters
scalarThe second operand of the binary operation (this[i] is the first operand.
Returns
The matrix "this" modified.

◆ Add() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Add ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

Store back binary elementwise operations between two matrices. For each element of the matrices, performs \( this[i] \leftarrow op(this[i], otherMatrix[i])\) where \(op\) is either an addition (Add), a subtraction (Subtraction), a multiplication (ElementwiseMultiply) or a division (ElementwiseDivide), a minimization (ElementwiseMin) or a maximisation (ElementwiseMax).

Parameters
otherMatrixThe second operand of the binary operation (this[i] is the first operand)
Returns
The vector "this" modified.

◆ AddElementwiseProductOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride1, stride_type __colStride1, class __dataPtrType1, stride_type __rowStride2, stride_type __colStride2, class __dataPtrType2>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::AddElementwiseProductOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride1, __colStride1, value_type, __dataPtrType1 > & matrix1,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride2, __colStride2, value_type, __dataPtrType2 > & matrix2 )
inline

◆ AddProductOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::AddProductOf ( const value_type scalar,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix )
inline

◆ Assign() [1/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Assign ( const value_type * elements,
bool inputIsRowMajor = true )
inline

Assign to this matrix a set of values provided as independent arguments, by using cstdarg macros, that is, an unspecified number of arguments. This function is not using a recursive engine, as it may be hard and not worthwhile to use a recursive engine with the va_arg ``iterator''. This operation assumes that all the arguments are of type value_type, and that their number is equal to the size of the matrix. The arguments are passed by value. The user may need to explicitly cast the parameters to value_type to avoid runtime bugs and errors. The order of the paramaters is row first which allows to keep the code pretty intuitive:

matrix.Assign( 0.0, 1.0,
-1.0, 0.0);
Returns
a reference to this matrix. */ inline ThisType & Assign(const value_type element0, ...) { iterator iter = begin(); (*iter) = element0; ++iter; va_list nextArg; va_start(nextArg, element0); for (; iter != end(); ++iter) { (*iter) = static_cast<value_type>(va_arg(nextArg, typename cmnTypeTraits<value_type>::VaArgPromotion)); } va_end(nextArg); return *this; }

/*! Assign to this matrix values from a C array given as a pointer to value_type. The purpose of this method is to simplify the syntax by not necessitating the creation of an explicit matrix for the given array. However, we only provide this method for an array of value_type. For arrays of other types a matrix still needs to be declared.

Parameters
elementsa pointer to a C array of elements to be assigned to this matrix.
inputIsRowMajora flag indicating the storage order of the elements in the input array.
Note
For lack of better knowledge, this method assumes that the input array is packed, that is, that all the elements are stored in a contiguous memory block with no gaps. The only existing options now relate to the storage order of the input elements. If the input is not packed, you should create a MatrixRef explicitly, with stride specifications, or use other tricks.
Returns
a reference to this object.

◆ Assign() [2/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<class __matrixOwnerType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Assign ( const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > & other)
inline

Assign to this matrix values from a dynamic matrix. This method doesn't allow type conversion.

Returns
a reference to this object.

◆ Assign() [3/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __elementType, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Assign ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, __elementType, __dataPtrType > & other)
inline

Assignment operation between matrices of different types

◆ at() [1/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::at ( size_type index)
inline

Access an element by index (non-const). Compare with std::vector::at(). This method can be a handy substitute for the overloaded operator () when operator overloading is unavailable or inconvenient.

Returns
a reference to the index-th element (iterator order)

◆ at() [2/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::at ( size_type index) const
inline

◆ at() [3/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::at ( size_type rowIndex,
size_type colIndex )
inline

Access an element by index. Compare with std::vector::at(). This method can be a handy substitute for the overloaded operator () when operator overloading is unavailable or inconvenient.

Returns
a reference to the element at rowIndex, colIndex

◆ at() [4/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::at ( size_type rowIndex,
size_type colIndex ) const
inline

◆ begin() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::begin ( )
inline

Returns an iterator on the first element (STL compatibility).

◆ begin() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::begin ( ) const
inline

◆ CeilOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::CeilOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ CeilSelf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::CeilSelf ( void )
inline

◆ ClipAbove()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ClipAbove ( const value_type upperBound)
inline

◆ ClipBelow()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ClipBelow ( const value_type lowerBound)
inline

◆ ClippedAboveOf() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ClippedAboveOf ( const value_type upperBound,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix )
inline

◆ ClippedAboveOf() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ClippedAboveOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix,
const value_type upperBound )
inline

◆ ClippedBelowOf() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ClippedBelowOf ( const value_type lowerBound,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix )
inline

◆ ClippedBelowOf() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ClippedBelowOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix,
const value_type lowerBound )
inline

◆ Column() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ColumnRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Column ( size_type index)
inline

Create a column reference.

◆ Column() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ConstColumnRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Column ( size_type index) const
inline

◆ ColumnInversePermutationOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ColumnInversePermutationOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > & inputMatrix,
const index_type permutedColumnIndexes[] )
inline

Assign a permutation of the columns of the input matrix to the column of this matrix. Both matrices must have the same size.

Parameters
inputMatrixthe input matrix for the permutation.
permutedColumnIndexesan array of column indices. The assignment performed is: this->Column( permutedColumnIndexes[i] ) <– inputMatrix.Column(i).
Note
The current implementation does not validate that the input permuted indexes is an actual permutation of the numbers 0..(COLS-1). Nor does it assure that the input permutation array has the right size. Both are the caller's responsibility.
Do not use this method for an in-place permutation of the input matrix.

◆ ColumnPermutationOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ColumnPermutationOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > & inputMatrix,
const index_type permutedColumnIndexes[] )
inline

Assign a permutation of the columns of the input matrix to the column of this matrix. Both matrices must have the same size.

Parameters
inputMatrixthe input matrix for the permutation.
permutedColumnIndexesan array of column indices. The assignment performed is: this->Column(i) <– inputMatrix.Column( permutedColumnIndexes[i] ).
Note
The current implementation does not validate that the input permuted indexes is an actual permutation of the numbers 0..(COLS-1). Nor does it assure that the input permutation array has the right size. Both are the caller's responsibility.
Do not use this method for an in-place permutation of the input matrix.

◆ DeSerializeRaw()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::DeSerializeRaw ( std::istream & inputStream)
inline

Binary deserialization

◆ Diagonal() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
DiagonalRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Diagonal ( void )
inline

Create a reference to the main diagonal

◆ Diagonal() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ConstDiagonalRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Diagonal ( void ) const
inline

◆ DifferenceOf() [1/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::DifferenceOf ( const value_type scalar,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix )
inline

◆ DifferenceOf() [2/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::DifferenceOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > & input1Matrix,
const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > & input2Matrix )
inline

◆ DifferenceOf() [3/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::DifferenceOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix,
const value_type scalar )
inline

◆ Divide()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Divide ( const value_type scalar)
inline

◆ Element() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Element ( size_type rowIndex,
size_type colIndex )
inline

Access an element by indices (non const). This method allows to access an element without any bounds checking. It doesn't create any temporary row reference as a matrix[][] would do.

Returns
a reference to the element at rowIndex, colIndex

◆ Element() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Element ( size_type rowIndex,
size_type colIndex ) const
inline

◆ ElementwiseDivide()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseDivide ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ ElementwiseMax()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseMax ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ ElementwiseMaxOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseMaxOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > & input1Matrix,
const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > & input2Matrix )
inline

◆ ElementwiseMin()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseMin ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ ElementwiseMinOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseMinOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > & input1Matrix,
const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > & input2Matrix )
inline

◆ ElementwiseMultiply()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseMultiply ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ ElementwiseProductOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseProductOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > & input1Matrix,
const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > & input2Matrix )
inline

◆ ElementwiseRatioOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseRatioOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > & input1Matrix,
const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > & input2Matrix )
inline

◆ end() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::end ( )
inline

Returns an iterator on the last element (STL compatibility).

◆ end() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::end ( ) const
inline

◆ ExchangeColumns()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ExchangeColumns ( const size_type col1Index,
const size_type col2Index )
inline

Exchange two colums of the matrix

◆ ExchangeRows()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ExchangeRows ( const size_type row1Index,
const size_type row2Index )
inline

Exchange two rows of the matrix

◆ FastCopyOf() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<class __matrixOwnerType>
bool vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::FastCopyOf ( const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > & source,
bool performSafetyChecks = vctFastCopy::PerformChecks )
inline

Fast copy. This method uses memcpy whenever it is possible to perform a fast copy from another matrix to this matrix.

  • The method will first verify that the source and destination have the same size (rows and columns) and throws an exception otherwise (std::runtime_error). See cmnThrow for details.
  • If any of the two matrices is not compact or if the two matrices use a different storage order, this method will return false. If both matrices are compact and use the same storage order, a memcpy is performed and the method returns true.
  • If the two matrices are compact by row or column, this method will use multiple calls to memcpy, i.e. one per row or column and the method returns true
  • To avoid the tests above, one can set the parameter performSafetyChecks to vctFastCopy::SkipChecks (boolean defined false). This should be used only when the programmer knows for sure that the source and destination are compatible (size, storage order and compactness).
  • As opposed to Assign, this method doesn't perform any type conversion.
  • Since no constructor is called for the contained elements, this function performs a "shallow copy". If the contained objects have a pointer as data member, the copied object will carry on the same pointer (hence pointing at the same memory block which could easily lead to bugs).

The basic and safe use of this method for a matrix would be:

if (!destination.FastCopyOf(source)) {
destination.Assign(source);
}

If the method is to be called many times (in a loop for example), it is recommended to check that the source and destination are compatible once and then use the option to turn off the different safety checks for each FastCopyOf.

bool canUseFastCopy = destination.FastCopyCompatible(source);
vct::index_type index;
for (index = 0; index < 1000; index++) {
DoSomethingUseful(source);
if (canUseFastCopy) {
destination.FastCopyOf(source, vctFastCopy::SkipChecks); // Do not check again
} else {
destination.Assign(source);
}
}
vctFastCopy::SkipChecks
static const bool SkipChecks
Definition vctFastCopy.h:118
vct::index_type
size_t index_type
Definition vctContainerTraits.h:36
Parameters
sourceMatrix used to set the content of this matrix.
performSafetyChecksFlag set to false to avoid safety checks, use with extreme caution. To make your code more readable use vctFastCopy::SkipChecks or vctFastCopy::PerformChecks.

◆ FastCopyOf() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<class __dataPtrType>
bool vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::FastCopyOf ( const vctFixedSizeConstMatrixBase< ROWS, COLS, ROWSTRIDE, COLSTRIDE, value_type, __dataPtrType > & source,
bool performSafetyChecks = vctFastCopy::PerformChecks )
inline

◆ FloorOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::FloorOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ FloorSelf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::FloorSelf ( void )
inline

◆ ForceAssign() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<class __matrixOwnerType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ForceAssign ( const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > & other)
inline

◆ ForceAssign() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __elementType, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ForceAssign ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, __elementType, __dataPtrType > & other)
inline

◆ FromStreamRaw()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::FromStreamRaw ( std::istream & inputStream,
const char delimiter = ' ' )
inline

Read from an unformatted text input (e.g., one created by ToStreamRaw). Returns true if successful.

◆ Multiply()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Multiply ( const value_type scalar)
inline

◆ NegationOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::NegationOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ NegationSelf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::NegationSelf ( void )
inline

◆ operator()() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator() ( size_type rowIndex,
size_type colIndex )
inline

Access an element by index. See method at().

Returns
a const reference to element[rowIndex, colIndex]

◆ operator()() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_reference vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator() ( size_type rowIndex,
size_type colIndex ) const
inline

◆ operator*=()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator*= ( const value_type scalar)
inline

◆ operator+=() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator+= ( const value_type scalar)
inline

◆ operator+=() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator+= ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ operator-=() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator-= ( const value_type scalar)
inline

◆ operator-=() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator-= ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ operator/=()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator/= ( const value_type scalar)
inline

◆ operator[]() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
RowRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator[] ( size_type index)
inline

Reference a row of this matrix by index (non-const).

Returns
a const reference to the element[index]

◆ operator[]() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ConstRowRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator[] ( size_type index) const
inline

◆ OuterProductOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __stride1, class __dataPtrType1, stride_type __stride2, class __dataPtrType2>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::OuterProductOf ( const vctFixedSizeConstVectorBase< _rows, __stride1, _elementType, __dataPtrType1 > & columnVector,
const vctFixedSizeConstVectorBase< _cols, __stride2, _elementType, __dataPtrType2 > & rowVector )
inline

Compute the outer product of two vectors and store the result to this matrix. The outer product (v1*v2)[i,j] = v1[i] * v2[j]

◆ Pointer() [1/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
pointer vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Pointer ( size_type rowIndex,
size_type colIndex )
inline

Returns a non const pointer to an element of the container, specified by its index. Addition to the STL requirements.

◆ Pointer() [2/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_pointer vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Pointer ( size_type rowIndex,
size_type colIndex ) const
inline

◆ Pointer() [3/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
pointer vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Pointer ( void )
inline

Returns a non const pointer to the first element of the container. Addition to the STL requirements.

◆ Pointer() [4/4]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_pointer vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Pointer ( void ) const
inline

◆ ProductOf() [1/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ProductOf ( const value_type scalar,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix )
inline

◆ ProductOf() [2/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<size_type __input1Cols, stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ProductOf ( const vctFixedSizeConstMatrixBase< _rows, __input1Cols, __input1RowStride, __input1ColStride, _elementType, __input1DataPtrType > & input1Matrix,
const vctFixedSizeConstMatrixBase< __input1Cols, _cols, __input2RowStride, __input2ColStride, _elementType, __input2DataPtrType > & input2Matrix )
inline

Product of two matrices. The template parameters insure that the size of the matrices match.

Parameters
input1MatrixThe left operand of the binary operation.
input2MatrixThe right operand of the binary operation.
Returns
The matrix "this" modified.

◆ ProductOf() [3/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ProductOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix,
const value_type scalar )
inline

◆ RatioOf() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RatioOf ( const value_type scalar,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix )
inline

◆ RatioOf() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RatioOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix,
const value_type scalar )
inline

◆ rbegin() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
reverse_iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::rbegin ( )
inline

Returns a reverse iterator on the last element (STL compatibility).

◆ rbegin() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_reverse_iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::rbegin ( ) const
inline

◆ Ref() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<vct::size_type __subRows, vct::size_type __subCols>
vctFixedSizeMatrixRef< _elementType, __subRows, __subCols, _rowStride, _colStride > vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Ref ( const size_type startRow = 0,
const size_type startCol = 0 )
inline

Create a reference to a sub matrix

◆ Ref() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<vct::size_type __subRows, vct::size_type __subCols>
vctFixedSizeConstMatrixRef< _elementType, __subRows, __subCols, _rowStride, _colStride > vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Ref ( const size_type startRow = 0,
const size_type startCol = 0 ) const
inline

◆ rend() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
reverse_iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::rend ( )
inline

Returns a reverse iterator on the element before first (STL compatibility).

◆ rend() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const_reverse_iterator vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::rend ( ) const
inline

◆ Row() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
RowRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Row ( size_type index)
inline

Create a row reference.

◆ Row() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ConstRowRefType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Row ( size_type index) const
inline

◆ RowInversePermutationOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RowInversePermutationOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > & inputMatrix,
const index_type permutedRowIndexes[] )
inline

Assign a permutation of the rows of the input matrix to the rows of this matrix. Both matrices must have the same size.

Parameters
inputMatrixthe input matrix for the permutation.
permutedRowIndexesan array of row indices. The assignment performed is: this->Row( permutedRowIndexes[i] ) <– inputMatrix.Row(i).
Note
The current implementation does not validate that the input permuted indexes is an actual permutation of the numbers 0..(ROWS-1). Nor does it assure that the input permutation array has the right size. Both are the caller's responsibility.
Do not use this method for an in-place permutation of the input matrix.

◆ RowPermutationOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RowPermutationOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > & inputMatrix,
const index_type permutedRowIndexes[] )
inline

Assign a permutation of the rows of the input matrix to the rows of this matrix. Both matrices must have the same size.

Parameters
inputMatrixthe input matrix for the permutation.
permutedRowIndexesan array of row indices. The assignment performed is: this->Row(i) <– inputMatrix.Row( permutedRowIndexes[i] ).
Note
The current implementation does not validate that the input permuted indexes is an actual permutation of the numbers 0..(ROWS-1). Nor does it assure that the input permutation array has the right size. Both are the caller's responsibility.
Do not use this method for an in-place permutation of the input matrix.

◆ SelectColsFrom()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<size_type __cols, stride_type __rowStride, stride_type __colStride, class __dataPtrType, stride_type __indexStride, class __indexDataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::SelectColsFrom ( const vctFixedSizeConstMatrixBase< _rows, __cols, __rowStride, __colStride, _elementType, __dataPtrType > & inputMatrix,
const vctFixedSizeConstVectorBase< _cols, __indexStride, index_type, __indexDataPtrType > & colIndexVector )
inline

Select a subset of columns from another matrix

◆ SelectRowsFrom()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<size_type __rows, stride_type __rowStride, stride_type __colStride, class __dataPtrType, stride_type __indexStride, class __indexDataPtrType>
void vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::SelectRowsFrom ( const vctFixedSizeConstMatrixBase< __rows, _cols, __rowStride, __colStride, _elementType, __dataPtrType > & inputMatrix,
const vctFixedSizeConstVectorBase< _rows, __indexStride, index_type, __indexDataPtrType > & rowIndexVector )
inline

Select a subset of rows from another matrix

◆ SetAll()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::SetAll ( const value_type value)
inline

Assign the given value to all the elements.

Parameters
valuethe value used to set all the elements of the matrix
Returns
The value used to set all the elements

◆ Subtract() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Subtract ( const value_type scalar)
inline

◆ Subtract() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Subtract ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ SumOf() [1/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::SumOf ( const value_type scalar,
const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix )
inline

Binary elementwise operations between a scalar and a matrix. For each element of the matrix "this", performs \( this[i] \leftarrow op(scalar, matrix[i])\) where \(op\) is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters
scalarThe first operand of the binary operation.
matrixThe second operand of the binary operation.
Returns
The matrix "this" modified.

◆ SumOf() [2/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __input1RowStride, stride_type __input1ColStride, class __input1DataPtrType, stride_type __input2RowStride, stride_type __input2ColStride, class __input2DataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::SumOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __input1RowStride, __input1ColStride, value_type, __input1DataPtrType > & input1Matrix,
const vctFixedSizeConstMatrixBase< _rows, _cols, __input2RowStride, __input2ColStride, value_type, __input2DataPtrType > & input2Matrix )
inline

Binary elementwise operations between two matrices. For each element of the matrices, performs \( this[i] \leftarrow op(matrix1[i], matrix2[i])\) where \(op\) is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ElementwiseProductOf), a division (ElementwiseRatioOf), a minimum (ElementwiseMinOf) or a maximum (ElementwiseMaxOf).

Parameters
input1MatrixThe first operand of the binary operation
input2MatrixThe second operand of the binary operation
Returns
The vector "this" modified.

◆ SumOf() [3/3]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::SumOf ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & matrix,
const value_type scalar )
inline

Binary elementwise operations between a matrix and a scalar. For each element of the matrix "this", performs \( this[i] \leftarrow op(matrix[i], scalar)\) where \(op\) is either an addition (SumOf), a subtraction (DifferenceOf), a multiplication (ProductOf), a division (RatioOf), a minimum (ClippedAboveOf) or a maximum (ClippedBelowOf).

Parameters
matrixThe first operand of the binary operation.
scalarThe second operand of the binary operation.
Returns
The matrix "this" modified.

◆ TransposeOf()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
template<stride_type __rowStride, stride_type __colStride, class __dataPtrType>
ThisType & vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::TransposeOf ( const vctFixedSizeConstMatrixBase< _cols, _rows, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix)
inline

◆ TransposeRef() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RefTransposeType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::TransposeRef ( void )
inline

Return a transposed reference to this matrix. The actual definition of this method follows the declaration of class vctFixedSizeMatrixRef.

◆ TransposeRef() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
ConstRefTransposeType vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::TransposeRef ( void ) const
inline

◆ VCT_CONTAINER_TRAITS_TYPEDEFS()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::VCT_CONTAINER_TRAITS_TYPEDEFS ( _elementType )

◆ Zeros()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Zeros ( void )
inline

Assign zero to all elements. This methods assumes that the element type has a zero and this zero value can be set using memset(0). If the matrix is not compact this method will use SetAll(0) and memset otherwise. This provides a slightly more efficent way to set all elements to zero.

Returns
true if the matrix is compact and memset was used, false otherwise.
The documentation for this class was generated from the following files:
Generated by doxygen 1.18.0