cisst-saw
Loading...
Searching...
No Matches
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType > Class Template Reference

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

#include <vctFixedSizeConstMatrixBase.h>

Inheritance diagram for vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >:
vctFixedSizeMatrixBase< _rows, _cols, _rowMajor?_cols:1, _rowMajor?1:_rows, _elementType, typename vctFixedSizeMatrixTraits< _elementType, _rows, _cols, _rowMajor?_cols:1, _rowMajor?1:_rows >::array > vctFixedSizeMatrixBase< _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  ConstSubmatrix

Public Types

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, COLSTRIDEConstRowRefType
typedef vctFixedSizeVectorRef< _elementType, COLS, COLSTRIDERowRefType
typedef vctFixedSizeConstVectorRef< _elementType, ROWS, ROWSTRIDEConstColumnRefType
typedef vctFixedSizeVectorRef< _elementType, ROWS, ROWSTRIDEColumnRefType
typedef vctFixedSizeConstVectorRef< _elementType, DIAGONAL_LENGTH, DIAGONAL_STRIDEConstDiagonalRefType
typedef vctFixedSizeVectorRef< _elementType, DIAGONAL_LENGTH, DIAGONAL_STRIDEDiagonalRefType
typedef vctFixedSizeVector< _elementType, COLSRowValueType
typedef vctFixedSizeVector< _elementType, ROWSColumnValueType
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<=ROWSTRIDETransposeValueType
typedef vctFixedSizeMatrix< _elementType, ROWS, COLS, COLSTRIDE<=ROWSTRIDEMatrixValueType
typedef vctFixedSizeMatrix< bool, ROWS, COLS, COLSTRIDE<=ROWSTRIDEBoolMatrixValueType
typedef _dataPtrType DataType

Public Member Functions

 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
Incremental operations returning a scalar.

Compute a scalar from all the elements of the matrix.

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
Storage format.
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
Elementwise comparisons between matrices.

Returns the matrix of comparison's results.

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
Elementwise comparisons between a matrix and a scalar.

Returns the result of the comparison.

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

Protected Member Functions

void ThrowUnlessValidIndex (size_type index) const CISST_THROW(std
void ThrowUnlessValidIndex (size_type rowIndex, size_type colIndex) const CISST_THROW(std

Protected Attributes

DataType Data

Unary elementwise operations.

Returns the result of matrix.op().

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
static const MatrixValueTypeEye (void)

Detailed Description

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

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

The matrix can be defined over an existing memory block, or define its own memory block. The class's methods follow the STL specifications for Random Access Container. It uses vctFixedSizeMatrixTraits to define the types required by the STL interface.

This class defines a read-only memory matrix. The read/write matrix is derived from this class (compare with vctFixedStrideMatrixConstIterator). Therefore, all the methods of this class are const. The non-const matrix and methods are defined in vctFixedSizeMatrixBase.

Matrix indexing is zero-based.

The method provided for the compatibility with the STL containers start with a lower case. Other methods start with a capitalilized letter (see CISST naming convention).

Parameters
_elementTypethe type of element in the matrix.
_rowsthe number of rows that the matrix provides access to.
_colsthe number of columns that the matrix provides access to.
_rowStridethe spacing between the rows in the memory block.
_colStridethe spacing between the columns in the memory block.
_dataPtrTypethe type of object that defines the matrix. This may be an element pointer of an acutal fixed-size C-style array type.
See also
vctFixedStrideMatrixConstIterator vctFixedSizeMatrixTraits

Member Typedef Documentation

◆ BoolMatrixValueType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeMatrix<bool, ROWS, COLS, COLSTRIDE <= ROWSTRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::BoolMatrixValueType

The type of a matrix of booleans returned from operations on this object, e.g., ElementwiseEqual. The storage order is determined by comparing the strides.

◆ ColumnRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeVectorRef<_elementType, ROWS, ROWSTRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ColumnRefType

The type indicating a column of this matrix accessed by (non-const) reference

◆ ColumnValueType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeVector<_elementType, ROWS> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ColumnValueType

The type of vector object required to store a copy of a column of this matrix

◆ 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 vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::const_iterator

Const iterator on the elements of the matrix.

◆ 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 vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::const_reverse_iterator

Const reverse iterator on the elements of the matrix.

◆ ConstColumnRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeConstVectorRef<_elementType, ROWS, ROWSTRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ConstColumnRefType

The type indicating a column of this matrix accessed by (const) reference

◆ ConstDiagonalRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeConstVectorRef<_elementType, DIAGONAL_LENGTH, DIAGONAL_STRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ConstDiagonalRefType

The type indicating the main diagonal of the matrix accessed by (const) reference

◆ ConstRefTransposeType

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

The type of object representing this matrix accessed in transposed order. Access is by (const) reference

◆ ConstRefType

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

The type of const reference to this matrix.

◆ ConstRowRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeConstVectorRef<_elementType, COLS, COLSTRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ConstRowRefType

The type indicating a row of this matrix accessed by (const) reference

◆ DataType

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

◆ DiagonalRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeVectorRef<_elementType, DIAGONAL_LENGTH, DIAGONAL_STRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::DiagonalRefType

The type indicating the main diagonal of the matrix accessed by (non-const) reference

◆ 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 vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::iterator

Iterator on the elements of the matrix.

◆ 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> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MatrixTraits

Traits used for all useful types related to a vctFixedSizeMatrix

◆ MatrixValueType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeMatrix<_elementType, ROWS, COLS, COLSTRIDE <= ROWSTRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MatrixValueType

The type of a matrix returned by value from operations on this object. The storage order is determined by comparing the strides.

◆ RefTransposeType

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

The type of object representing this matrix accessed in transposed order. Access is by (non-const) reference

◆ RefType

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

The type of reference to this matrix.

◆ 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 vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::reverse_iterator

Reverse iterator on the elements of the matrix.

◆ RowRefType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeVectorRef<_elementType, COLS, COLSTRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RowRefType

The type indicating a row of this matrix accessed by (non-const) reference

◆ RowValueType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeVector<_elementType, COLS> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::RowValueType

The type of vector object required to store a copy of a row of this matrix

◆ ThisType

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> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ThisType

Type of the matrix itself.

◆ TransposeValueType

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
typedef vctFixedSizeMatrix<_elementType, COLS, ROWS, COLSTRIDE <= ROWSTRIDE> vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::TransposeValueType

The type of object required to store a transposed copy of this matrix. The storage order is determined by comparing the strides.

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 properties of the main diagonal of the matrix

Enumerator
DIAGONAL_LENGTH 
DIAGONAL_STRIDE 

◆ 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
Enumerator
DIMENSION 

◆ 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

◆ Abs()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Abs ( void ) const
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 (Abs) or the opposite (Negation).

Returns
A new matrix.

◆ All()

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

Return true if all the elements of this matrix are nonzero, false otherwise

◆ AlmostEqual() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::AlmostEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ AlmostEqual() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::AlmostEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix,
value_type tolerance ) const
inline

◆ Any()

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

Return true if any element of this matrix is nonzero, false otherwise

◆ at() [1/2]

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

Access an element by index (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 const reference to the index-th element (iterator order)

◆ at() [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 vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::at ( size_type rowIndex,
size_type colIndex ) const
inline

Access an element by index (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 const reference to the element at rowIndex, colIndex

◆ begin()

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

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

◆ Ceil()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Ceil ( void ) const
inline

◆ col_stride()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
difference_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::col_stride ( ) const
inline

Returns the column stride. Not required by STL but provided for completeness.

◆ cols()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
size_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::cols ( ) const
inline

Return the number of matrix columns. Using smallcase naming following STL

◆ Column()

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

◆ Diagonal()

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

◆ Element()

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

Access an element by indices (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

◆ ElementwiseEqual() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseEqual ( const value_type & scalar) const
inline

Comparison between a matrix and a scalar, containing the same type of elements. The comparaison ( \( = \neq < \leq > \geq \)) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the matrix and the scalar and stored in a newly created matrix. There is no operator provided since the semantic would be ambiguous.

Returns
A matrix of booleans.

◆ ElementwiseEqual() [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>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_dataPtrType) can be different. The comparaison ( \( = \neq < \leq > \geq \)) for ElementwiseEqual(), ElementwiseNotEqual(), ElementwiseLesser(), ElementwiseLesserOrEqual(), ElementwiseGreater() or ElementwiseGreaterOrEqual() is performed elementwise between the two matrices and stored in a newly created matrix. There is no operator provided since the semantic would be ambiguous.

Returns
A matrix of booleans.

◆ ElementwiseGreater() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseGreater ( const value_type & scalar) const
inline

◆ ElementwiseGreater() [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>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseGreater ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ ElementwiseGreaterOrEqual() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseGreaterOrEqual ( const value_type & scalar) const
inline

◆ ElementwiseGreaterOrEqual() [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>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseGreaterOrEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ ElementwiseLesser() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseLesser ( const value_type & scalar) const
inline

◆ ElementwiseLesser() [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>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseLesser ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ ElementwiseLesserOrEqual() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseLesserOrEqual ( const value_type & scalar) const
inline

◆ ElementwiseLesserOrEqual() [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>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseLesserOrEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ ElementwiseNotEqual() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseNotEqual ( const value_type & scalar) const
inline

◆ ElementwiseNotEqual() [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>
BoolMatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ElementwiseNotEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ empty()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::empty ( ) const
inline

Tell is the vector is empty (STL compatibility). False unless SIZE is zero.

◆ end()

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

Returns a const iterator on the past-the-last element (STL compatibility).

◆ Equal() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Equal ( const value_type & scalar) const
inline

Comparison between a matrix and a scalar, containing the same type of elements. The comparaison ( \( = \neq < \leq > \geq \)) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the matrix and the scalar. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results.. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns
A boolean.

◆ Equal() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Equal ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_dataPtrType) can be different. The comparaison ( \( = \neq < \leq > \geq \)) for Equal(), NotEqual(), Lesser(), LesserOrEqual(), Greater() or GreaterOrEqual() is performed elementwise between the two matrices. A logical "and" is performed (except for NotEqual which uses a logical "or") to accumulate the elementwise results. The only operators provided are "==" and "!=" since the semantic is not ambiguous.

Returns
A boolean.

◆ Eye()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MatrixValueType & vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Eye ( void )
static

Return the identity matrix for the size and type of elements of this matrix class. For example:

MatrixType m3 = MatrixType::Eye();
Implementation of a fixed-size matrix using template metaprogramming.
Definition vctFixedSizeMatrix.h:54
vctFixedSizeMatrix< int, 3, 3 > vctInt3x3
Definition vctFixedSizeMatrixTypes.h:106
vctFixedSizeMatrix< double, 4, 4 > vct4x4
Definition vctFixedSizeMatrixTypes.h:70
Note
Eye is the spelling of "I".

◆ FastCopyCompatible() [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 vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::FastCopyCompatible ( const vctDynamicConstMatrixBase< __matrixOwnerType, value_type > & source) const
inline

Test if the method FastCopyOf can be used instead of Assign. See FastCopyOf for more details.

◆ FastCopyCompatible() [2/2]

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, size_type __cols, stride_type __rowStride, stride_type __colStride, class __dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::FastCopyCompatible ( const vctFixedSizeConstMatrixBase< __rows, __cols, __rowStride, __colStride, value_type, __dataPtrType > & source) const
inline

Test if the method FastCopyOf can be used instead of Assign. See FastCopyOf for more details.

◆ Floor()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Floor ( void ) const
inline

◆ Greater() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Greater ( const value_type & scalar) const
inline

◆ Greater() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Greater ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ GreaterOrEqual() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::GreaterOrEqual ( const value_type & scalar) const
inline

◆ GreaterOrEqual() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::GreaterOrEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ HasNaN()

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

Return true if any element of this matrix is NaN, false otherwise

◆ IsColMajor()

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

Test if the matrix storage order is column major.

Returns
true if the row stride is lesser or equal to the column stride.

◆ IsCompact()

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

Test if the matrix is compact, i.e. a m by n matrix actually uses a contiguous block of memory or size m by n.

◆ IsFinite()

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

Return true if all the elements of this matrix are finite, false otherwise

◆ IsFortran()

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

Test if the matrix is "Fortran" compatible, i.e. is compact and uses a column major storage order.

See also
IsColMajor IsCompact

◆ IsNegative()

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

Return true if all the elements of this vector are strictly negative, false otherwise

◆ IsNonNegative()

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

Return true if all the elements of this vector are non-negative, false otherwise

◆ IsNonPositive()

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

Return true if all the elements of this vector are non-positive, false otherwise

◆ IsPositive()

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

Return true if all the elements of this vector are strictly positive, false otherwise

◆ IsRowMajor()

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

Test if the matrix storage order is row major.

Returns
true if the column stride is lesser or equal to the row stride.

◆ IsSquare() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::IsSquare ( size_type size) const
inline

Test if a matrix is square and of a given size.

◆ IsSquare() [2/2]

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

Test if a matrix is square.

◆ L1Norm()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::L1Norm ( void ) const
inline

Return the L1 norm of the matrix, i.e. the sum of the absolute values of all the elements.

Returns
The L1 norm.

◆ Lesser() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Lesser ( const value_type & scalar) const
inline

◆ Lesser() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Lesser ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ LesserOrEqual() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::LesserOrEqual ( const value_type & scalar) const
inline

◆ LesserOrEqual() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::LesserOrEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ LinfNorm()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::LinfNorm ( void ) const
inline

Return the Linf norm of the matrix, i.e. the maximum of the absolute values of all the elements.

See also
MaxAbsElement
Returns
The Linf norm.

◆ max_size()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
size_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::max_size ( ) const
inline

Returns the maximum size of the matrix or vector (STL compatibility). For a fixed size matrix or vector, same as the size().

◆ MaxAbsElement()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MaxAbsElement ( void ) const
inline

Return the maximum of the absolute values of all the elements.

See also
LinfNorm.
Returns
The maximum of the absolute values.

◆ MaxElement()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MaxElement ( void ) const
inline

Return the maximum element of the matrix.

Returns
The maximum element

◆ MinAbsElement()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MinAbsElement ( void ) const
inline

Return the minimum of the absolute values of all the elements.

Returns
The minimum of the absolute values.

◆ MinAndMaxElement()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MinAndMaxElement ( value_type & minElement,
value_type & maxElement ) const
inline

Compute the minimum AND maximum elements of the matrix. This method is more runtime-efficient than computing them separately.

Parameters
minElementreference to store the minimum element result.
maxElementreference to store the maximum element result.
Note
If this matrix is empty (null pointer) the result is undefined.

◆ MinElement()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MinElement ( void ) const
inline

Return the minimum element of the matrix.

Returns
The minimum element

◆ Negation()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::MatrixValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Negation ( void ) const
inline

◆ Norm()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
NormType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Norm ( void ) const
inline

Return the norm of the matrix.

Returns
The norm.

◆ NormSquare()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::NormSquare ( void ) const
inline

Return the square of the norm of the matrix.

Returns
The square of the norm

◆ NotEqual() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::NotEqual ( const value_type & scalar) const
inline

◆ NotEqual() [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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::NotEqual ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator!= ( const value_type & scalar) const
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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator!= ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ operator()()

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

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

Returns
a const reference to element[rowIndex, colIndex]

◆ operator==() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator== ( const value_type & scalar) const
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>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::operator== ( const vctFixedSizeConstMatrixBase< _rows, _cols, __rowStride, __colStride, value_type, __dataPtrType > & otherMatrix) const
inline

◆ operator[]()

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

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

Returns
a const reference to the element[index]

◆ Pointer() [1/2]

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

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

◆ Pointer() [2/2]

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

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

◆ ProductOfElements()

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

Return the product of the elements of the matrix.

Returns
The product of all the elements

◆ rbegin()

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

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

◆ Ref()

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 > vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Ref ( const size_type startRow = 0,
const size_type startCol = 0 ) const
inline

Create a const reference to a sub matrix

◆ rend()

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

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

◆ Row()

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

◆ row_stride()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
difference_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::row_stride ( ) const
inline

Returns the row stride. Not required by STL but provided for completeness.

◆ rows()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
size_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::rows ( ) const
inline

Return the number of matrix rows. Using smallcase naming following STL

◆ SerializeRaw()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::SerializeRaw ( std::ostream & outputStream) const
inline

Binary serialization

◆ size()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
size_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::size ( ) const
inline

Returns the size of the matrix or vector (STL compatibility).

◆ sizes()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const nsize_type & vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::sizes ( void ) const
inline

Return a fixed size vector containing the number of rows and columns.

◆ StorageOrder()

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

Return the storage order, i.e. either VCT_ROW_MAJOR or VCT_COL_MAJOR.

◆ strides()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
const nstride_type & vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::strides ( void ) const
inline

Return a fixed size vector containing the row and column strides.

◆ SumOfElements()

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

Return the sum of the elements of the matrix.

Returns
The sum of all the elements

◆ ThrowUnlessValidIndex() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ThrowUnlessValidIndex ( size_type index) const
inlineprotected

Check the validity of an index.

◆ ThrowUnlessValidIndex() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ThrowUnlessValidIndex ( size_type rowIndex,
size_type colIndex ) const
inlineprotected

Check the validity of the row and column indices.

◆ ToStream()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ToStream ( std::ostream & outputStream) const
inline

Print the matrix in a human readable format

◆ ToStreamRaw()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
void vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ToStreamRaw ( std::ostream & outputStream,
const char delimiter = ' ',
bool headerOnly = false,
const std::string & headerPrefix = "" ) const
inline

Print data only with optional separator

◆ ToString()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
std::string vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ToString ( void ) const
inline

Return a string representation of the matrix elements

◆ Trace()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
value_type vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Trace ( void ) const
inline

Return the trace of the matrix, i.e. the sum of elements of its diagonal.

Returns
The trace of the matrix.

◆ Transpose()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
TransposeValueType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Transpose ( ) const
inline

Return a transposed copy of this matrix.

◆ TransposeRef()

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

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

◆ ValidColIndex()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ValidColIndex ( size_type colIndex) const
inline

Returns true if colIndex is a valid column index.

◆ ValidIndex() [1/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ValidIndex ( size_type index) const
inline

Returns true if the index is lesser or equal to the number of elements of the matrix.

◆ ValidIndex() [2/2]

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ValidIndex ( size_type rowIndex,
size_type colIndex ) const
inline

Returns true if both rowIndex and colIndex are valid indices.

◆ ValidRowIndex()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
bool vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::ValidRowIndex ( size_type rowIndex) const
inline

Returns true if rowIndex is a valid row index.

◆ 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>
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::VCT_CONTAINER_TRAITS_TYPEDEFS ( _elementType )

◆ VCT_NARRAY_TRAITS_TYPEDEFS()

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::VCT_NARRAY_TRAITS_TYPEDEFS ( DIMENSION )

Member Data Documentation

◆ Data

template<vct::size_type _rows, vct::size_type _cols, vct::stride_type _rowStride, vct::stride_type _colStride, class _elementType, class _dataPtrType>
DataType vctFixedSizeConstMatrixBase< _rows, _cols, _rowStride, _colStride, _elementType, _dataPtrType >::Data
protected

A declaration of the matrix-defining member object


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