ERC-CISST Software

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicConstMatrixBase<_matrixOwnerType, _elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ThisType

Type of the matrix itself.

Definition at line 89 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef _matrixOwnerType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::OwnerType

Type of the data owner (dynamic array or pointer)

Definition at line 92 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef OwnerType::iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::iterator

Iterator on the elements of the matrix.

Definition at line 95 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef OwnerType::const_iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::const_iterator

Const iterator on the elements of the matrix.

Definition at line 98 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef OwnerType::reverse_iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::reverse_iterator

Reverse iterator on the elements of the matrix.

Definition at line 101 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef OwnerType::const_reverse_iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::const_reverse_iterator

Const reverse iterator on the elements of the matrix.

Definition at line 104 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicConstVectorRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ConstRowRefType

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

Definition at line 108 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicVectorRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::RowRefType

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

Definition at line 112 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicConstVectorRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ConstColumnRefType

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

Definition at line 116 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicVectorRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ColumnRefType

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

Definition at line 120 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicConstVectorRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ConstDiagonalRefType

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

Definition at line 124 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicVectorRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::DiagonalRefType

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

Definition at line 128 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicConstMatrixRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ConstRefTransposeType

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

Definition at line 132 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicMatrixRef<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::RefTransposeType

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

Definition at line 136 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicMatrix<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::TransposeValueType

The type of object required to store a transposed copy of this matrix

Definition at line 140 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicMatrix<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::MatrixValueType

The type of a matrix used to store by value results of the same type as this object.

Definition at line 144 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctReturnDynamicMatrix<_elementType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::MatrixReturnType

The type of a matrix returned by value from operations on this object

Definition at line 148 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef TypeTraits::BoolType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::BoolType

Define bool based on the container type to force some compilers (i.e. gcc 4.0) to delay the instantiation of the ElementWiseCompare methods.

Definition at line 155 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctReturnDynamicMatrix<BoolType> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::BoolMatrixReturnType

The type of a matrix of booleans returned from operations on this object, e.g., ElementwiseEqual.

Definition at line 159 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicVector<const_pointer> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ConstVectorPointerType

The type of vector used to store const pointers on the rows or columns

Definition at line 162 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

typedef vctDynamicVector<pointer> vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::VectorPointerType

The type of vector used to store pointers on the rows or columns

Definition at line 165 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

void vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ThrowUnlessValidIndex ( size_type index ) const throw (std::out_of_range) [inline, protected]

Check the validity of an index.

Definition at line 174 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::at(), and vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::at().

template<class _matrixOwnerType, typename _elementType>

void vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ThrowUnlessValidIndex	(	size_type	rowIndex,
		size_type	colIndex
	)			const throw (std::out_of_range) `[inline, protected]`

Check the validity of the row and column indices.

Definition at line 182 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

void vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ThrowUnlessValidRowIndex ( size_type index ) const throw (std::out_of_range) [inline, protected]

Throw an exception unless the row index is valid

Definition at line 190 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::Row(), and vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Row().

template<class _matrixOwnerType, typename _elementType>

void vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ThrowUnlessValidColIndex ( size_type index ) const throw (std::out_of_range) [inline, protected]

Throw an exception unless the column index is valid

Definition at line 197 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::Column(), and vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Column().

template<class _matrixOwnerType, typename _elementType>

const_iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::begin ( void ) const [inline]

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

Definition at line 206 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::at(), and vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::begin().

template<class _matrixOwnerType, typename _elementType>

const_iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::end ( void ) const [inline]

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

Definition at line 212 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::end().

template<class _matrixOwnerType, typename _elementType>

const_reverse_iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::rbegin ( void ) const [inline]

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

Definition at line 218 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::rbegin().

template<class _matrixOwnerType, typename _elementType>

const_reverse_iterator vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::rend ( void ) const [inline]

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

Definition at line 224 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::rend().

template<class _matrixOwnerType, typename _elementType>

size_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::size ( void ) const [inline]

Return the number of elements in the matrix. This is not equivalent to the difference between the end and the beginning.

Definition at line 231 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::empty(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ValidIndex(), and vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::Zeros().

template<class _matrixOwnerType, typename _elementType>

const nsize_type& vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::sizes ( void ) const [inline]

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

Definition at line 236 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrix< svlTarget2D >::ForceAssign(), vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef(), and vctDynamicMatrixRef< CISSTNETLIB_DOUBLE >::vctDynamicMatrixRef().

template<class _matrixOwnerType, typename _elementType>

size_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::rows ( ) const [inline]

Not required by STL but provided for completeness

Definition at line 241 of file vctDynamicConstMatrixBase.h.

Referenced by nmrSVDEconomyDynamicData::Allocate(), nmrSVDDynamicData::Allocate(), nmrPInverseEconomyDynamicData::Allocate(), nmrPInverseDynamicData::Allocate(), nmrNNLSDynamicData::Allocate(), nmrLUDynamicData::Allocate(), nmrLSqLinSolutionDynamic::Allocate(), nmrLSEISolver::Allocate(), nmrIsOrthonormalDynamicData< _elementType >::Allocate(), nmrInverseDynamicData::Allocate(), nmrHFTISolver::Allocate(), vctQuaternionRotation3Base< vctFixedSizeVector< double, 4 > >::ApplyInverseTo(), vctMatrixRotation3ConstBase< vctFixedSizeMatrix< double, 3, 3, _rowMajor > >::ApplyInverseTo(), vctFrameBase< _rotationType >::ApplyInverseTo(), vctQuaternionRotation3Base< vctFixedSizeVector< double, 4 > >::ApplyTo(), vctMatrixRotation3ConstBase< vctFixedSizeMatrix< double, 3, 3, _rowMajor > >::ApplyTo(), vctFrameBase< _rotationType >::ApplyTo(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Column(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Diagonal(), nmrLSqLinSolutionDynamic::GetIWorkspaceSize(), nmrLSqLinSolutionDynamic::GetWorkspaceSize(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::IsFortran(), nmrLUDynamicData::MatrixLSize(), nmrLUDynamicData::MatrixPSize(), nmrSVDEconomyDynamicData::MatrixSSize(), nmrSVDDynamicData::MatrixSSize(), nmrLUDynamicData::MatrixUSize(), nmrIsOrthonormal(), nmrLSqLin(), nmrLSqLinSolutionDynamic::nmrLSqLinSolutionDynamic(), nmrPInverseDynamicData::nmrPInverseDynamicData(), nmrPInverseEconomyDynamicData::nmrPInverseEconomyDynamicData(), operator *(), operator+(), operator-(), operator/(), vctDynamicMatrix< svlTarget2D >::operator=(), mtsMatrix< _elementType >::operator=(), nmrInverseDynamicData::PivotIndicesSize(), vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::RowInversePermutationOf(), vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::RowPermutationOf(), vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::RowPointers(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::RowPointers(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::SerializeRaw(), vctFixedSizeMatrixRef< _elementType, 3, 3, _rowStride, _colStride >::SetRef(), vctFixedSizeConstMatrixRef< _elementType, 3, 3, _rowStride, _colStride >::SetRef(), vctDynamicNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicMatrixRef< CISSTNETLIB_DOUBLE >::SetRef(), vctDynamicConstNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicConstMatrixRef< _elementType >::SetRef(), nmrPInverseEconomyDynamicData::SetRef(), nmrPInverseDynamicData::SetRef(), nmrLSqLinSolutionDynamic::SetRef(), nmrIsOrthonormalDynamicData< _elementType >::SetRef(), nmrPInverseEconomyDynamicData::SetRefOutput(), nmrPInverseDynamicData::SetRefOutput(), nmrSVDEconomyDynamicData::SetRefWorkspace(), nmrSVDDynamicData::SetRefWorkspace(), nmrPInverseEconomyDynamicData::SetRefWorkspace(), nmrPInverseDynamicData::SetRefWorkspace(), nmrNNLSDynamicData::SetRefWorkspaces(), nmrLSEISolver::Solve(), nmrHFTISolver::Solve(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ToStream(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ToStreamRaw(), vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::TransposeRef(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::TransposeRef(), nmrLUSolver::UpdateLU(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ValidIndex(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ValidRowIndex(), vctDynamicMatrix< svlTarget2D >::vctDynamicMatrix(), vctRandom(), vctReturnDynamicMatrix< _elementType >::vctReturnDynamicMatrix(), nmrSVDEconomyDynamicData::WorkspaceSize(), nmrSVDDynamicData::WorkspaceSize(), nmrPInverseEconomyDynamicData::WorkspaceSize(), nmrPInverseDynamicData::WorkspaceSize(), nmrNNLSDynamicData::WorkspaceSize(), nmrIsOrthonormalDynamicData< _elementType >::WorkspaceSize(), nmrInverseDynamicData::WorkspaceSize(), and vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::Zeros().

template<class _matrixOwnerType, typename _elementType>

size_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::cols ( ) const [inline]

Not required by STL but provided for completeness

Definition at line 246 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

size_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::height ( ) const [inline]

Not required by STL but provided for completeness

Definition at line 251 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

size_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::width ( ) const [inline]

Not required by STL but provided for completeness

Definition at line 256 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ToStream().

template<class _matrixOwnerType, typename _elementType>

const nstride_type& vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::strides ( void ) const [inline]

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

Definition at line 261 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef(), and vctDynamicMatrixRef< CISSTNETLIB_DOUBLE >::vctDynamicMatrixRef().

template<class _matrixOwnerType, typename _elementType>

difference_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::row_stride ( ) const [inline]

Not required by STL but provided for completeness

Definition at line 266 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

difference_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::col_stride ( ) const [inline]

Not required by STL but provided for completeness

Definition at line 271 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::empty ( ) const [inline]

Tell is the matrix is empty (STL compatibility). False unless size is zero.

Definition at line 277 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

ConstRowRefType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::operator[] ( size_type index ) const [inline]

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

Returns:: a const reference to the element[index]

Definition at line 283 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::operator[]().

template<class _matrixOwnerType, typename _elementType>

const_reference vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::at ( size_type index ) const throw (std::out_of_range) [inline]

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

Returns:: a const reference to element[index]

Definition at line 292 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::at(), and vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::operator()().

template<class _matrixOwnerType, typename _elementType>

const OwnerType& vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Owner ( void ) const [inline]

Access the matrix owner. This method should be used only to access some extra information related to the memory layout. It is used by the engines (vctDynamicMatrixLoopEngines).

Definition at line 301 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::Owner().

template<class _matrixOwnerType, typename _elementType>

const_pointer vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Pointer	(	index_type	rowIndex,
		index_type	colIndex
	)			const `[inline]`

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

Definition at line 309 of file vctDynamicConstMatrixBase.h.

Referenced by vctQuaternionRotation3Base< vctFixedSizeVector< double, 4 > >::ApplyInverseTo(), vctMatrixRotation3ConstBase< vctFixedSizeMatrix< double, 3, 3, _rowMajor > >::ApplyInverseTo(), vctFrameBase< _rotationType >::ApplyInverseTo(), vctQuaternionRotation3Base< vctFixedSizeVector< double, 4 > >::ApplyTo(), vctMatrixRotation3ConstBase< vctFixedSizeMatrix< double, 3, 3, _rowMajor > >::ApplyTo(), vctFrameBase< _rotationType >::ApplyTo(), vctFixedSizeConstMatrixRef< _elementType, 3, 3, _rowStride, _colStride >::SetRef(), vctDynamicNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicConstNArrayRef< _elementType, _dimension >::SetRef(), vctDynamicConstMatrixRef< _elementType >::SetRef(), vctDynamicConstMatrixRef< _elementType >::vctDynamicConstMatrixRef(), and vctDynamicMatrixRef< CISSTNETLIB_DOUBLE >::vctDynamicMatrixRef().

template<class _matrixOwnerType, typename _elementType>

const_pointer vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Pointer ( void ) const [inline]

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

Definition at line 316 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::at(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Column(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Diagonal(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Element(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::operator[](), vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::Pointer(), vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Row(), and vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::TransposeRef().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ValidIndex ( size_type index ) const [inline]

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

Definition at line 323 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ThrowUnlessValidIndex().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ValidIndex	(	size_type	rowIndex,
		size_type	colIndex
	)			const `[inline]`

Returns true if both rowIndex and colIndex are valid indices.

Definition at line 329 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ValidRowIndex ( size_type rowIndex ) const [inline]

Returns true if rowIndex is a valid row index.

Definition at line 335 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ThrowUnlessValidRowIndex().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ValidColIndex ( size_type colIndex ) const [inline]

Returns true if colIndex is a valid column index.

Definition at line 340 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ThrowUnlessValidColIndex().

template<class _matrixOwnerType, typename _elementType>

const_reference vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::at	(	size_type	rowIndex,
		size_type	colIndex
	)			const throw (std::out_of_range) `[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

Definition at line 349 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

const_reference vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::operator()	(	size_type	rowIndex,
		size_type	colIndex
	)			const throw (std::out_of_range) `[inline]`

Overloaded operator () for simplified (const) element access with bounds checking

Definition at line 355 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::operator()().

template<class _matrixOwnerType, typename _elementType>

const_reference vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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

Definition at line 365 of file vctDynamicConstMatrixBase.h.

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

template<class _matrixOwnerType, typename _elementType>

ConstVectorPointerType& vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::RowPointers ( ConstVectorPointerType & rowPointers ) const throw (std::runtime_error) [inline]

Resize and fill a vector of const pointers on the rows of the matrix. This method is provided to ease the interfacing with C libraries using matrices stored as value_type**.

To use this method, one must first create a dynamic vector of pointers, update it with the RowPointers method and then call the C function:

      vctDynamicMatrix<double> myMatrix = ...;
      vctDynamicVector<double *> rowPointers;
      myMatrix.RowPointers(rowPointers);
      c_function(rowPointers.Pointer());

Note:: This method will throw an exception if the rows are not compact, i.e. if the column stride is not equal to 1.

Definition at line 402 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::RowPointers().

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::SumOfElements ( void ) const [inline]

Return the sum of the elements of the matrix.

Returns:: The sum of all the elements

Definition at line 423 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ProductOfElements ( void ) const [inline]

Return the product of the elements of the matrix.

Returns:: The product of all the elements

Definition at line 432 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 443 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::NormSquare ( void ) const [inline]

Return the square of the norm of the matrix.

Returns:: The square of the norm

Definition at line 449 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::Norm().

template<class _matrixOwnerType, typename _elementType>

NormType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Norm ( void ) const [inline]

Return the norm of the matrix.

Returns:: The norm.

Definition at line 458 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 466 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 479 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::AlmostEqual().

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::MaxElement ( void ) const [inline]

Return the maximum element of the matrix.

Returns:: The maximum element

Definition at line 485 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::MinElement ( void ) const [inline]

Return the minimum element of the matrix.

Returns:: The minimum element

Definition at line 494 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 507 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::LinfNorm().

template<class _matrixOwnerType, typename _elementType>

value_type vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::MinAbsElement ( void ) const [inline]

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

Returns:: The minimum of the absolute values.

Definition at line 518 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

void vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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:

	minElement	reference to store the minimum element result.
	maxElement	reference to store the maximum element result.

Note:: If this matrix is empty (null pointer) the result is undefined.

Definition at line 532 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::IsPositive ( void ) const [inline]

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

Definition at line 539 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::IsNonNegative ( void ) const [inline]

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

Definition at line 548 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::IsNonPositive ( void ) const [inline]

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

Definition at line 557 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::IsNegative ( void ) const [inline]

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

Definition at line 566 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::All ( void ) const [inline]

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

Definition at line 575 of file vctDynamicConstMatrixBase.h.

Referenced by vctAll().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Any ( void ) const [inline]

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

Definition at line 584 of file vctDynamicConstMatrixBase.h.

Referenced by vctAny().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 600 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::IsFortran().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 608 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 614 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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

Definition at line 623 of file vctDynamicConstMatrixBase.h.

Referenced by nmrHFTISolver::Solve().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::StorageOrder ( void ) const [inline]

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

Definition at line 629 of file vctDynamicConstMatrixBase.h.

Referenced by nmrSVDEconomyDynamicData::Allocate(), nmrSVDDynamicData::Allocate(), nmrPInverseEconomyDynamicData::Allocate(), nmrPInverseDynamicData::Allocate(), nmrInverseDynamicData::Allocate(), vctDynamicMatrix< svlTarget2D >::ForceAssign(), nmrPInverseDynamicData::nmrPInverseDynamicData(), nmrPInverseEconomyDynamicData::nmrPInverseEconomyDynamicData(), vctDynamicMatrix< svlTarget2D >::operator=(), mtsMatrix< _elementType >::operator=(), nmrPInverseEconomyDynamicData::SetRef(), nmrPInverseDynamicData::SetRef(), nmrPInverseEconomyDynamicData::SetRefOutput(), nmrPInverseDynamicData::SetRefOutput(), nmrSVDEconomyDynamicData::SetRefWorkspace(), nmrSVDDynamicData::SetRefWorkspace(), nmrPInverseEconomyDynamicData::SetRefWorkspace(), nmrPInverseDynamicData::SetRefWorkspace(), vctDynamicMatrix< svlTarget2D >::vctDynamicMatrix(), and vctReturnDynamicMatrix< _elementType >::vctReturnDynamicMatrix().

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::IsSquare ( void ) const [inline]

Test if a matrix is square.

Definition at line 634 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::IsSquare ( size_type size ) const [inline]

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

Definition at line 639 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 650 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<size_type __rows, size_type __cols, stride_type __rowStride, stride_type __colStride, class __dataPtrType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

Definition at line 656 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Equal ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 679 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::operator==().

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::operator== ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 688 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::AlmostEqual	(	const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > &	otherMatrix,
		value_type	tolerance
	)			const `[inline]`

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 694 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::AlmostEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 701 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::NotEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 707 of file vctDynamicConstMatrixBase.h.

Referenced by vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::operator!=().

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::operator!= ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 716 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Lesser ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 722 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::LesserOrEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 731 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Greater ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 740 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::GreaterOrEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides 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.

Definition at line 749 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_matrixOwnerType) 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.

Definition at line 774 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseNotEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_matrixOwnerType) 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.

Definition at line 782 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseLesser ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_matrixOwnerType) 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.

Definition at line 790 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseLesserOrEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_matrixOwnerType) 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.

Definition at line 798 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseGreater ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_matrixOwnerType) 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.

Definition at line 806 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

template<class __matrixOwnerType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseGreaterOrEqual ( const vctDynamicConstMatrixBase< __matrixOwnerType, _elementType > & otherMatrix ) const [inline]

Comparison between two matrices of the same size, containing the same type of elements. The strides and the internal representation (_matrixOwnerType) 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.

Definition at line 814 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Equal ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 837 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::operator== ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 845 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::NotEqual ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 850 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::operator!= ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 858 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Lesser ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 863 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::LesserOrEqual ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 871 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Greater ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 879 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

bool vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::GreaterOrEqual ( const value_type & scalar ) const [inline]

Comparison between a matrix and a scalar. The type of the elements of the matrix and the scalar must be the same. 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.

Definition at line 887 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseEqual ( const value_type & scalar ) const

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.

template<class _matrixOwnerType, typename _elementType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseNotEqual ( const value_type & scalar ) const

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.

template<class _matrixOwnerType, typename _elementType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseLesser ( const value_type & scalar ) const

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.

template<class _matrixOwnerType, typename _elementType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseLesserOrEqual ( const value_type & scalar ) const

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.

template<class _matrixOwnerType, typename _elementType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseGreater ( const value_type & scalar ) const

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.

template<class _matrixOwnerType, typename _elementType>

BoolMatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ElementwiseGreaterOrEqual ( const value_type & scalar ) const

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.

template<class _matrixOwnerType, typename _elementType>

MatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::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.

template<class _matrixOwnerType, typename _elementType>

MatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Negation ( 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.

template<class _matrixOwnerType, typename _elementType>

MatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Floor ( 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.

template<class _matrixOwnerType, typename _elementType>

MatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Ceil ( 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.

template<class _matrixOwnerType, typename _elementType>

ConstRefTransposeType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::TransposeRef ( void ) const [inline]

Return a transposed reference to this matrix. This allows access to elements of this matrix in transposed order.

Definition at line 953 of file vctDynamicConstMatrixBase.h.

Referenced by nmrIsOrthonormal(), vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::SelectColsFrom(), vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::TransposeOf(), and vctDynamicMatrixBase< vctDynamicMatrixOwner< float >, float >::TransposeRef().

template<class _matrixOwnerType, typename _elementType>

MatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Transpose ( ) const [inline]

Return a transposed copy of this matrix

Definition at line 959 of file vctDynamicConstMatrixBase.h.

Referenced by nmrPInverseSolver::Solve().

template<class _matrixOwnerType, typename _elementType>

static MatrixReturnType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Eye ( size_type size ) [static]

Return the identity matrix for the type of elements of this matrix class. The size has to be specified by the caller. For example:

      vctDoubleMat m = vctDoubleMat::Eye(12);
      typedef vctDynamicMatrix<float> MatrixType;
      MatrixType m2 = MatrixType::Eye(9);

Note:: Eye is the spelling of "I".

template<class _matrixOwnerType, typename _elementType>

std::string vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ToString ( void ) [inline]

Return a string representation of the matrix elements

Definition at line 980 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

void vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::ToStream ( std::ostream & outputStream ) const [inline]

Print the matrix to a text stream

Reimplemented in mtsMatrix< _elementType >.

Definition at line 987 of file vctDynamicConstMatrixBase.h.

Referenced by operator<<(), and vctDynamicConstMatrixBase< vctDynamicMatrixOwner< float >, float >::ToString().

template<class _matrixOwnerType, typename _elementType>

void vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::SerializeRaw ( std::ostream & outputStream ) const [inline]

Binary serialization

Reimplemented in mtsMatrix< _elementType >.

Definition at line 1080 of file vctDynamicConstMatrixBase.h.

template<class _matrixOwnerType, typename _elementType>

OwnerType vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >::Matrix [protected]

Declaration of the matrix-defining member object

Definition at line 170 of file vctDynamicConstMatrixBase.h.

	_matrixOwnerType	the type of matrix owner.
	_elementType	the type of elements of the matrix.

vctDynamicConstMatrixBase< _matrixOwnerType, _elementType > Class Template Reference

Detailed Description

template<class _matrixOwnerType, typename _elementType>
class vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Classes

Member Typedef Documentation

Member Function Documentation

Member Data Documentation

vctDynamicConstMatrixBase< _matrixOwnerType, _elementType > Class Template Reference

Detailed Description

template<class _matrixOwnerType, typename _elementType> class vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Classes

Member Typedef Documentation

Member Function Documentation

Member Data Documentation

template<class _matrixOwnerType, typename _elementType>
class vctDynamicConstMatrixBase< _matrixOwnerType, _elementType >