Matrix class that include the boost::ublas::matrix. More...

#include <jrl/mal/boostmatrix.hh>

Inheritance diagram for maal::boost::Matrix:

Public Types
typedef ::boost::numeric::ublas::matrix< FloatType >	InternalMatrix

Public Member Functions
Constructors
	Matrix (const unsigned int rows=0, const unsigned int cols=0)
	Classical constructor.
	Matrix (InternalMatrix *clone, const bool proprio=false)
	Build only the capsule around a already existing boost vector object.
	Matrix (const Matrix &copy)
	Build a new internal vector from existing boost vector object by copying the data.
virtual	~Matrix (void)
InternalMatrix &	accessToMotherLib (void)
	Access to the boost internal vector.
const InternalMatrix &	accessToMotherLib (void) const
	Access to the boost internal vector.
Matrix &	initFromMotherLib (const InternalMatrix &bv)
	Copy the values and data of an existing boost vector.
Modifiors
Matrix &	resize (const unsigned int nbRows, const unsigned int nbCols, const bool setZero=true)
unsigned int	nbRows (void) const
	Get the number of rows.
unsigned int	nbCols (void) const
	Get the number of columns.
Matrix &	setZero (void)
Matrix &	setIdentity (void)
Matrix &	fill (const FloatType value)
Scalar Operator E->R
FloatType	determinant (void) const
FloatType	trace (void) const
	Not implemented yet.
FloatType	norm (void) const
	Not implemented yet.
FloatType	norm1 (void) const
	Norm 1 sum( \|xi\| ).
FloatType	normInfty (void) const
FloatType	max (void) const
	Not implemented yet.
FloatType	min (void) const
	Not implemented yet.
FloatType	sumSquare (void) const
	Not implemented yet.
Inverse
Matrix &	transpose (Matrix &At) const
Matrix	transpose (void) const
Matrix &	inverse (Matrix &invMatrix) const
	Compute the inverse of the matrix.
Matrix	inverse (void) const
virtual Matrix &	pseudoInverse (Matrix &invMatrix, const FloatType threshold=1e-6, Matrix Uref=NULL, Vector Sref=NULL, Matrix *Vref=NULL) const
	Compute the pseudo-inverse of the matrix.
Matrix	pseudoInverse (const FloatType threshold=1e-6, Matrix U=NULL, Vector S=NULL, Matrix *V=NULL) const
virtual Matrix &	dampedInverse (Matrix &invMatrix, const FloatType threshold=1e-6, Matrix Uref=NULL, Vector Sref=NULL, Matrix *Vref=NULL) const
	Compute the pseudo-inverse of the matrix.
Matrix	dampedInverse (const FloatType threshold=1e-6, Matrix U=NULL, Vector S=NULL, Matrix *V=NULL) const
Matrix &	opposite (Matrix &res) const
	Compute the opposite of the matrix -M.
Matrix	opposite (void) const
	Compute the opposite of the matrix -M.
Accessors
Access to an element, a block of element or the hidden double-array matrix.
FloatType *	datablock (void)
const FloatType *	datablock (void) const
Matrix &	extract (const int top, const int left, const int nbrows, const int nbcols, Matrix &C) const
Matrix	extract (const int top, const int left, const int nbrows, const int nbcols)
const FloatType &	elementAt (const int row, const int col) const
FloatType &	elementAt (const int row, const int col)
const FloatType &	elementAt (const int elmt) const
FloatType &	elementAt (const int elmt)
Bonus
Additional functions, not implemented yet.
Vector	getDiagonal (void) const
Vector &	getDiagonal (Vector &vector) const
Matrix &	setDiagonal (const Vector &vector)
Matrix &	stackMatrix (const Matrix &, Matrix &C) const
Matrix	stackMatrix (const Matrix &B) const
Matrix &	juxtaposeMatrix (const Matrix &, Matrix &C) const
Matrix	juxtaposeMatrix (const Matrix &B) const

Public Attributes
InternalMatrix	staticMatrix
InternalMatrix *	dynamicMatrix
InternalMatrix &	matrix
bool	proprio

Static Public Attributes
static const bool	AUTORESIZE = true
static const bool	CHECKRESIZE = true

Operators
Classical operators: use v1 + v2 for addition, v1(i) for i-th element...
class	Vector
Matrix	operator+ (const Matrix &m1, const Matrix &m2)
Matrix	operator- (const Matrix &m1, const Matrix &m2)
Matrix	operator* (const Matrix &m1, const Matrix &m2)
Matrix	operator- (const Matrix &m)
Vector	operator* (const Matrix &M, const Vector &v1)
Vector	operator* (const Vector &v1, const Matrix &M)
Matrix	operator+ (const FloatType x, const Matrix &m1)
Matrix	operator- (const FloatType x, const Matrix &m1)
Matrix	operator* (const FloatType x, const Matrix &m1)
Matrix	operator/ (const FloatType x, const Matrix &m1)
Matrix	operator+ (const Matrix &m1, const FloatType x)
Matrix	operator- (const Matrix &m1, const FloatType x)
Matrix	operator* (const Matrix &m1, const FloatType x)
Matrix	operator/ (const Matrix &m1, const FloatType x)
std::ostream &	operator<< (std::ostream &os, const Matrix &m1)
std::istream &	operator>> (std::istream &is, Matrix &v1)
Matrix &	operator+= (const Matrix &m1)
Matrix &	operator-= (const Matrix &m1)
Matrix &	operator*= (const Matrix &m1)
Matrix &	operator*= (const FloatType x)
const FloatType &	operator() (const int i, const int j) const
FloatType &	operator() (const int i, const int j)
const FloatType &	operator() (const int n) const
FloatType &	operator() (const int n)
Matrix &	operator= (const Matrix &m1)

Operator Functions ExE->E
Each C-style function is implemented as a C++ operator.
Matrix &	multiply (const Matrix &A, const Matrix &B, Matrix &C)
Vector &	multiply (const Matrix &M, const Vector &v, Vector &res)
Matrix &	addition (const Matrix &A, const Matrix &B, Matrix &C)
Matrix &	substraction (const Matrix &A, const Matrix &B, Matrix &C)
Matrix &	multiply (const Matrix &A, const FloatType x, Matrix &C)
Matrix &	addition (const Matrix &A, const FloatType x, Matrix &C)
Matrix &	substraction (const Matrix &A, const FloatType x, Matrix &C)
Matrix &	division (const Matrix &A, const FloatType x, Matrix &C)
Matrix	multiply (const Matrix &B) const
Matrix &	multiply (const Matrix &B, Matrix &C) const
Vector	multiply (const Vector &v) const
Vector &	multiply (const Vector &v, Vector &res) const
Matrix	addition (const Matrix &B) const
Matrix &	addition (const Matrix &B, Matrix &C) const
Matrix	substraction (const Matrix &B) const
Matrix &	substraction (const Matrix &B, Matrix &C) const
Matrix	multiply (const FloatType x) const
Matrix &	multiply (const FloatType x, Matrix &C) const
Matrix	addition (const FloatType x) const
Matrix &	addition (const FloatType x, Matrix &C) const
Matrix	substraction (const FloatType x) const
Matrix &	substraction (const FloatType x, Matrix &C) const
Matrix	division (const FloatType x) const
Matrix &	division (const FloatType x, Matrix &C) const

Autoresize internal
bool	autoresize (void)
static void	_resize (InternalMatrix &mat1, const InternalMatrix &mat2)
static bool	_checksize (const InternalMatrix &mat1, const InternalMatrix &mat2)
static bool	_checksizeVerb (const InternalMatrix &mat1, const InternalMatrix &mat2)
static bool	_checksize (const InternalMatrix &mat1, const unsigned int s1, const unsigned int s2)
static bool	_checksizeVerb (const InternalMatrix &mat1, const unsigned int s1, const unsigned int s2)
static bool	_checksizeProd (const InternalMatrix &mat1, const InternalMatrix &mat2)
static bool	_checksizeProdVerb (const InternalMatrix &mat1, const InternalMatrix &mat2)
static void	_resizeProd (InternalMatrix &res, const InternalMatrix &mat1, const InternalMatrix &mat2)
static bool	_checksizeProd (const InternalMatrix &mat1, const Vector::InternalVector &vct)
static bool	_checksizeProdVerb (const InternalMatrix &mat1, const Vector::InternalVector &vct)
static void	_resizeProd (Vector::InternalVector &res, const InternalMatrix &mat1)
static void	_resizeInv (InternalMatrix &res, const InternalMatrix &mat2)
static bool	_checksizeSquare (const InternalMatrix &mat1)
static bool	_checksizeSquareVerb (const InternalMatrix &mat1)

Detailed Description

Matrix class that include the boost::ublas::matrix.

The class encapsulates the ublas::matrix object, and implement a set of standard functions. When the maal::boost::Matrix object is constructed, it automatically builds the internal ublas::matrix object. The internal object can be access through accessToMotherLib. Finally, it is possible to build the capsule around an existing boost ublas::matrix through the appropriate constructor.

Member Typedef Documentation

◆ InternalMatrix

typedef ::boost::numeric::ublas::matrix<FloatType> maal::boost::Matrix::InternalMatrix

Constructor & Destructor Documentation

◆ Matrix() [1/3]

maal::boost::Matrix::Matrix	(	const unsigned int	rows = 0,
		const unsigned int	cols = 0 )

inline

Classical constructor.

Build the internal matrix from the demanded size.

References dynamicMatrix, matrix, and staticMatrix.

Referenced by addition(), addition(), addition, addition, addition(), addition(), dampedInverse(), dampedInverse(), maal::boost::MatrixSvd::dampedInverse(), division(), division(), division, extract(), extract(), fill(), initFromMotherLib(), inverse(), inverse(), juxtaposeMatrix(), juxtaposeMatrix(), Matrix(), maal::boost::MatrixSvd::MatrixSvd(), maal::boost::MatrixSvd::MatrixSvd(), maal::boost::MatrixSvd::MatrixSvd(), multiply(), multiply(), multiply, multiply, multiply(), multiply(), multiply, operator*, operator*, operator*, operator*, operator*, operator*=(), operator*=(), operator+, operator+, operator+, operator+=(), operator-, operator-, operator-, operator-, operator-=(), operator/, operator/, operator<<, operator=(), operator>>, opposite(), opposite(), pseudoInverse(), pseudoInverse(), maal::boost::MatrixSvd::pseudoInverse(), resize(), setDiagonal(), setIdentity(), setZero(), stackMatrix(), stackMatrix(), substraction(), substraction(), substraction, substraction, substraction(), substraction(), transpose(), and transpose().

◆ Matrix() [2/3]

maal::boost::Matrix::Matrix	(	InternalMatrix *	clone,
		const bool	proprio = false )

inline

Build only the capsule around a already existing boost vector object.

References dynamicMatrix, matrix, proprio, and staticMatrix.

◆ Matrix() [3/3]

maal::boost::Matrix::Matrix ( const Matrix & copy )

inline

Build a new internal vector from existing boost vector object by copying the data.

References dynamicMatrix, Matrix(), matrix, proprio, and staticMatrix.

◆ ~Matrix()

virtual maal::boost::Matrix::~Matrix ( void )

inlinevirtual

References dynamicMatrix, and proprio.

Member Function Documentation

◆ _checksize() [1/2]

bool maal::boost::Matrix::_checksize	(	const InternalMatrix &	mat1,
		const InternalMatrix &	mat2 )

inlinestaticprotected

References CHECKRESIZE.

Referenced by addition(), elementAt(), elementAt(), extract(), and substraction().

◆ _checksize() [2/2]

bool maal::boost::Matrix::_checksize	(	const InternalMatrix &	mat1,
		const unsigned int	s1,
		const unsigned int	s2 )

inlinestaticprotected

References CHECKRESIZE.

◆ _checksizeProd() [1/2]

bool maal::boost::Matrix::_checksizeProd	(	const InternalMatrix &	mat1,
		const InternalMatrix &	mat2 )

inlinestaticprotected

References CHECKRESIZE.

Referenced by multiply(), and multiply().

◆ _checksizeProd() [2/2]

bool maal::boost::Matrix::_checksizeProd	(	const InternalMatrix &	mat1,
		const Vector::InternalVector &	vct )

inlinestaticprotected

References CHECKRESIZE.

◆ _checksizeProdVerb() [1/2]

bool maal::boost::Matrix::_checksizeProdVerb	(	const InternalMatrix &	mat1,
		const InternalMatrix &	mat2 )

inlinestaticprotected

References CHECKRESIZE.

◆ _checksizeProdVerb() [2/2]

bool maal::boost::Matrix::_checksizeProdVerb	(	const InternalMatrix &	mat1,
		const Vector::InternalVector &	vct )

inlinestaticprotected

References CHECKRESIZE.

◆ _checksizeSquare()

bool maal::boost::Matrix::_checksizeSquare ( const InternalMatrix & mat1 )

inlinestaticprotected

References CHECKRESIZE.

◆ _checksizeSquareVerb()

bool maal::boost::Matrix::_checksizeSquareVerb ( const InternalMatrix & mat1 )

inlinestaticprotected

References CHECKRESIZE.

Referenced by determinant().

◆ _checksizeVerb() [1/2]

bool maal::boost::Matrix::_checksizeVerb	(	const InternalMatrix &	mat1,
		const InternalMatrix &	mat2 )

inlinestaticprotected

References CHECKRESIZE.

◆ _checksizeVerb() [2/2]

bool maal::boost::Matrix::_checksizeVerb	(	const InternalMatrix &	mat1,
		const unsigned int	s1,
		const unsigned int	s2 )

inlinestaticprotected

References CHECKRESIZE.

◆ _resize()

void maal::boost::Matrix::_resize	(	InternalMatrix &	mat1,
		const InternalMatrix &	mat2 )

inlinestaticprotected

References AUTORESIZE.

Referenced by dampedInverse().

◆ _resizeInv()

void maal::boost::Matrix::_resizeInv	(	InternalMatrix &	res,
		const InternalMatrix &	mat2 )

inlinestaticprotected

References AUTORESIZE.

Referenced by dampedInverse(), maal::boost::MatrixSvd::dampedInverse(), inverse(), pseudoInverse(), and maal::boost::MatrixSvd::pseudoInverse().

◆ _resizeProd() [1/2]

void maal::boost::Matrix::_resizeProd	(	InternalMatrix &	res,
		const InternalMatrix &	mat1,
		const InternalMatrix &	mat2 )

inlinestaticprotected

References AUTORESIZE.

Referenced by multiply().

◆ _resizeProd() [2/2]

void maal::boost::Matrix::_resizeProd	(	Vector::InternalVector &	res,
		const InternalMatrix &	mat1 )

inlinestaticprotected

References AUTORESIZE.

◆ accessToMotherLib() [1/2]

InternalMatrix & maal::boost::Matrix::accessToMotherLib ( void )

inline

Access to the boost internal vector.

References matrix.

◆ accessToMotherLib() [2/2]

const InternalMatrix & maal::boost::Matrix::accessToMotherLib ( void ) const

inline

Access to the boost internal vector.

References matrix.

◆ addition() [1/4]

Matrix maal::boost::Matrix::addition ( const FloatType x ) const

inline

References addition, Matrix(), nbCols(), and nbRows().

◆ addition() [2/4]

Matrix & maal::boost::Matrix::addition	(	const FloatType	x,
		Matrix &	C ) const

inline

References Matrix(), matrix, nbCols(), and nbRows().

◆ addition() [3/4]

Matrix maal::boost::Matrix::addition ( const Matrix & B ) const

inline

References addition, Matrix(), nbCols(), and nbRows().

◆ addition() [4/4]

Matrix & maal::boost::Matrix::addition	(	const Matrix &	B,
		Matrix &	C ) const

inline

References _checksize(), MAAL_CHECKVERBOSE, Matrix(), and matrix.

◆ autoresize()

bool maal::boost::Matrix::autoresize ( void )

inline

References AUTORESIZE.

◆ dampedInverse() [1/2]

Matrix maal::boost::Matrix::dampedInverse	(	const FloatType	threshold = 1e-6,
		Matrix *	U = NULL,
		Vector *	S = NULL,
		Matrix *	V = NULL ) const

inline

References dampedInverse(), Matrix(), nbCols(), nbRows(), and Vector.

◆ dampedInverse() [2/2]

virtual Matrix & maal::boost::Matrix::dampedInverse	(	Matrix &	invMatrix,
		const FloatType	threshold = 1e-6,
		Matrix *	Uref = NULL,
		Vector *	Sref = NULL,
		Matrix *	Vref = NULL ) const

inlinevirtual

Compute the pseudo-inverse of the matrix.

By default, the function uses the dgesvd_ fortran routine. It should be provided by the host software.

Reimplemented in maal::boost::MatrixSvd.

References _resize(), _resizeInv(), Matrix(), matrix, MRAWDATA, nbCols(), nbRows(), Vector, and VRAWDATA.

Referenced by dampedInverse().

◆ datablock() [1/2]

FloatType * maal::boost::Matrix::datablock ( void )

inline

References matrix, and MRAWDATA.

◆ datablock() [2/2]

const FloatType * maal::boost::Matrix::datablock ( void ) const

inline

References matrix, and MRAWDATA.

◆ determinant()

FloatType maal::boost::Matrix::determinant ( void ) const

inline

References _checksizeSquareVerb(), and matrix.

◆ division() [1/2]

Matrix maal::boost::Matrix::division ( const FloatType x ) const

inline

References division, Matrix(), nbCols(), and nbRows().

◆ division() [2/2]

Matrix & maal::boost::Matrix::division	(	const FloatType	x,
		Matrix &	C ) const

inline

References Matrix(), matrix, nbCols(), and nbRows().

◆ elementAt() [1/4]

FloatType & maal::boost::Matrix::elementAt ( const int elmt )

inline

References elementAt(), and nbRows().

◆ elementAt() [2/4]

const FloatType & maal::boost::Matrix::elementAt ( const int elmt ) const

inline

References elementAt(), and nbRows().

◆ elementAt() [3/4]

FloatType & maal::boost::Matrix::elementAt	(	const int	row,
		const int	col )

inline

References _checksize(), MAAL_CHECKVERBOSE, and matrix.

◆ elementAt() [4/4]

const FloatType & maal::boost::Matrix::elementAt	(	const int	row,
		const int	col ) const

inline

References _checksize(), MAAL_CHECKVERBOSE, and matrix.

Referenced by elementAt(), elementAt(), operator()(), and operator()().

◆ extract() [1/2]

Matrix maal::boost::Matrix::extract	(	const int	top,
		const int	left,
		const int	nbrows,
		const int	nbcols )

inline

References extract(), and Matrix().

◆ extract() [2/2]

Matrix & maal::boost::Matrix::extract	(	const int	top,
		const int	left,
		const int	nbrows,
		const int	nbcols,
		Matrix &	C ) const

inline

References _checksize(), MAAL_CHECKVERBOSE, Matrix(), and matrix.

Referenced by extract().

◆ fill()

Matrix & maal::boost::Matrix::fill ( const FloatType value )

inline

References Matrix(), and matrix.

Referenced by setDiagonal().

◆ getDiagonal() [1/2]

Vector & maal::boost::Matrix::getDiagonal ( Vector & vector ) const

inline

References matrix, nbCols(), nbRows(), maal::boost::Vector::resize(), and Vector.

◆ getDiagonal() [2/2]

Vector maal::boost::Matrix::getDiagonal ( void ) const

inline

References getDiagonal(), and Vector.

Referenced by getDiagonal().

◆ initFromMotherLib()

Matrix & maal::boost::Matrix::initFromMotherLib ( const InternalMatrix & bv )

inline

Copy the values and data of an existing boost vector.

References Matrix(), and matrix.

◆ inverse() [1/2]

Matrix & maal::boost::Matrix::inverse ( Matrix & invMatrix ) const

inline

Compute the inverse of the matrix.

The matrix has to be invertible. By default, the function uses the dgesvd_ fortran routine. It should be provided by the host software (i.e. lapack).

References _resizeInv(), Matrix(), and matrix.

◆ inverse() [2/2]

Matrix maal::boost::Matrix::inverse ( void ) const

inline

References inverse(), Matrix(), nbCols(), and nbRows().

Referenced by inverse().

◆ juxtaposeMatrix() [1/2]

Matrix & maal::boost::Matrix::juxtaposeMatrix	(	const Matrix &	,
		Matrix &	C ) const

inline

References Matrix(), and ML_NOT_IMPLEMENTED.

Referenced by juxtaposeMatrix().

◆ juxtaposeMatrix() [2/2]

Matrix maal::boost::Matrix::juxtaposeMatrix ( const Matrix & B ) const

inline

References juxtaposeMatrix(), and Matrix().

◆ max()

FloatType maal::boost::Matrix::max ( void ) const

inline

Not implemented yet.

References ML_NOT_IMPLEMENTED.

◆ min()

FloatType maal::boost::Matrix::min ( void ) const

inline

Not implemented yet.

References ML_NOT_IMPLEMENTED.

◆ multiply() [1/6]

Matrix maal::boost::Matrix::multiply ( const FloatType x ) const

inline

References Matrix(), multiply, nbCols(), and nbRows().

◆ multiply() [2/6]

Matrix & maal::boost::Matrix::multiply	(	const FloatType	x,
		Matrix &	C ) const

inline

References Matrix(), and matrix.

◆ multiply() [3/6]

Matrix maal::boost::Matrix::multiply ( const Matrix & B ) const

inline

References Matrix(), multiply, nbCols(), and nbRows().

◆ multiply() [4/6]

Matrix & maal::boost::Matrix::multiply	(	const Matrix &	B,
		Matrix &	C ) const

inline

References _checksizeProd(), _resizeProd(), MAAL_CHECKVERBOSE, Matrix(), and matrix.

◆ multiply() [5/6]

Vector maal::boost::Matrix::multiply ( const Vector & v ) const

inline

References multiply, nbRows(), and Vector.

◆ multiply() [6/6]

Vector & maal::boost::Matrix::multiply	(	const Vector &	v,
		Vector &	res ) const

inline

References _checksizeProd(), MAAL_CHECKVERBOSE, matrix, Vector, and maal::boost::Vector::vector.

◆ nbCols()

unsigned int maal::boost::Matrix::nbCols ( void ) const

inline

Get the number of columns.

References matrix.

Referenced by addition(), addition(), addition(), dampedInverse(), dampedInverse(), division(), division(), getDiagonal(), inverse(), multiply(), multiply(), pseudoInverse(), pseudoInverse(), resize(), substraction(), substraction(), substraction(), and transpose().

◆ nbRows()

unsigned int maal::boost::Matrix::nbRows ( void ) const

inline

Get the number of rows.

References matrix.

Referenced by addition(), addition(), addition(), dampedInverse(), dampedInverse(), division(), division(), elementAt(), elementAt(), getDiagonal(), inverse(), multiply(), multiply(), multiply(), pseudoInverse(), pseudoInverse(), resize(), substraction(), substraction(), substraction(), and transpose().

◆ norm()

FloatType maal::boost::Matrix::norm ( void ) const

inline

Not implemented yet.

References ML_NOT_IMPLEMENTED.

◆ norm1()

FloatType maal::boost::Matrix::norm1 ( void ) const

inline

Norm 1 sum( |xi| ).

References matrix.

◆ normInfty()

FloatType maal::boost::Matrix::normInfty ( void ) const

inline

References matrix.

◆ operator()() [1/4]

FloatType & maal::boost::Matrix::operator()	(	const int	i,
		const int	j )

inline

References matrix.

◆ operator()() [2/4]

const FloatType & maal::boost::Matrix::operator()	(	const int	i,
		const int	j ) const

inline

References matrix.

◆ operator()() [3/4]

FloatType & maal::boost::Matrix::operator() ( const int n )

inline

References elementAt().

◆ operator()() [4/4]

const FloatType & maal::boost::Matrix::operator() ( const int n ) const

inline

References elementAt().

◆ operator*=() [1/2]

Matrix & maal::boost::Matrix::operator*= ( const FloatType x )

inline

References Matrix(), and matrix.

◆ operator*=() [2/2]

Matrix & maal::boost::Matrix::operator*= ( const Matrix & m1 )

inline

References Matrix(), and multiply.

◆ operator+=()

Matrix & maal::boost::Matrix::operator+= ( const Matrix & m1 )

inline

References Matrix(), and matrix.

◆ operator-=()

Matrix & maal::boost::Matrix::operator-= ( const Matrix & m1 )

inline

References Matrix(), and matrix.

◆ operator=()

Matrix & maal::boost::Matrix::operator= ( const Matrix & m1 )

inline

References Matrix(), and matrix.

◆ opposite() [1/2]

Matrix & maal::boost::Matrix::opposite ( Matrix & res ) const

inline

Compute the opposite of the matrix -M.

References Matrix(), and matrix.

Referenced by operator-.

◆ opposite() [2/2]

Matrix maal::boost::Matrix::opposite ( void ) const

inline

Compute the opposite of the matrix -M.

References Matrix(), and opposite().

Referenced by opposite().

◆ pseudoInverse() [1/2]

Matrix maal::boost::Matrix::pseudoInverse	(	const FloatType	threshold = 1e-6,
		Matrix *	U = NULL,
		Vector *	S = NULL,
		Matrix *	V = NULL ) const

inline

References Matrix(), nbCols(), nbRows(), pseudoInverse(), and Vector.

◆ pseudoInverse() [2/2]

virtual Matrix & maal::boost::Matrix::pseudoInverse	(	Matrix &	invMatrix,
		const FloatType	threshold = 1e-6,
		Matrix *	Uref = NULL,
		Vector *	Sref = NULL,
		Matrix *	Vref = NULL ) const

inlinevirtual

Compute the pseudo-inverse of the matrix.

By default, the function uses the dgesvd_ fortran routine. It should be provided by the host software.

Reimplemented in maal::boost::MatrixSvd.

References _resizeInv(), Matrix(), matrix, MRAWDATA, nbCols(), nbRows(), Vector, and VRAWDATA.

Referenced by pseudoInverse().

◆ resize()

Matrix & maal::boost::Matrix::resize	(	const unsigned int	nbRows,
		const unsigned int	nbCols,
		const bool	setZero = true )

inline

References Matrix(), matrix, nbCols(), nbRows(), and setZero().

◆ setDiagonal()

Matrix & maal::boost::Matrix::setDiagonal ( const Vector & vector )

inline

References fill(), Matrix(), matrix, maal::boost::Vector::size(), and Vector.

◆ setIdentity()

Matrix & maal::boost::Matrix::setIdentity ( void )

inline

References Matrix(), and matrix.

◆ setZero()

Matrix & maal::boost::Matrix::setZero ( void )

inline

References Matrix(), and matrix.

Referenced by resize().

◆ stackMatrix() [1/2]

Matrix & maal::boost::Matrix::stackMatrix	(	const Matrix &	,
		Matrix &	C ) const

inline

References Matrix(), and ML_NOT_IMPLEMENTED.

Referenced by stackMatrix().

◆ stackMatrix() [2/2]

Matrix maal::boost::Matrix::stackMatrix ( const Matrix & B ) const

inline

References Matrix(), and stackMatrix().

◆ substraction() [1/4]

Matrix maal::boost::Matrix::substraction ( const FloatType x ) const

inline

References Matrix(), nbCols(), nbRows(), and substraction.

◆ substraction() [2/4]

Matrix & maal::boost::Matrix::substraction	(	const FloatType	x,
		Matrix &	C ) const

inline

References Matrix(), matrix, nbCols(), and nbRows().

◆ substraction() [3/4]

Matrix maal::boost::Matrix::substraction ( const Matrix & B ) const

inline

References Matrix(), nbCols(), nbRows(), and substraction.

◆ substraction() [4/4]

Matrix & maal::boost::Matrix::substraction	(	const Matrix &	B,
		Matrix &	C ) const

inline

References _checksize(), MAAL_CHECKVERBOSE, Matrix(), and matrix.

◆ sumSquare()

FloatType maal::boost::Matrix::sumSquare ( void ) const

inline

Not implemented yet.

References ML_NOT_IMPLEMENTED.

◆ trace()

FloatType maal::boost::Matrix::trace ( void ) const

inline

Not implemented yet.

◆ transpose() [1/2]

Matrix & maal::boost::Matrix::transpose ( Matrix & At ) const

inline

References Matrix(), and matrix.

◆ transpose() [2/2]

Matrix maal::boost::Matrix::transpose ( void ) const

inline

References Matrix(), nbCols(), nbRows(), and transpose().

Referenced by transpose().

◆ addition [1/2]

Matrix & addition	(	const Matrix &	A,
		const FloatType	x,
		Matrix &	C )

friend

References addition, and Matrix().

◆ addition [2/2]

Matrix & addition	(	const Matrix &	A,
		const Matrix &	B,
		Matrix &	C )

friend

References addition, and Matrix().

Referenced by addition(), addition, addition, addition(), operator+, operator+, and operator+.

◆ division

Matrix & division	(	const Matrix &	A,
		const FloatType	x,
		Matrix &	C )

friend

References division, and Matrix().

Referenced by division(), division, operator/, and operator/.

◆ multiply [1/3]

Matrix & multiply	(	const Matrix &	A,
		const FloatType	x,
		Matrix &	C )

friend

References Matrix(), and multiply.

◆ multiply [2/3]

Matrix & multiply	(	const Matrix &	A,
		const Matrix &	B,
		Matrix &	C )

friend

References Matrix(), and multiply.

Referenced by multiply(), multiply, multiply, multiply(), multiply, multiply(), operator*, operator*, operator*, operator*, operator*, and operator*=().

◆ multiply [3/3]

Vector & multiply	(	const Matrix &	M,
		const Vector &	v,
		Vector &	res )

friend

References Matrix(), multiply, and Vector.

◆ operator* [1/5]

Matrix operator*	(	const FloatType	x,
		const Matrix &	m1 )

friend

References Matrix(), and multiply.

◆ operator* [2/5]

Vector operator*	(	const Matrix &	M,
		const Vector &	v1 )

friend

References Matrix(), multiply, and Vector.

◆ operator* [3/5]

Matrix operator*	(	const Matrix &	m1,
		const FloatType	x )

friend

References Matrix(), and multiply.

◆ operator* [4/5]

Matrix operator*	(	const Matrix &	m1,
		const Matrix &	m2 )

friend

References Matrix(), and multiply.

◆ operator* [5/5]

Vector operator*	(	const Vector &	v1,
		const Matrix &	M )

friend

References Matrix(), multiply, and Vector.

◆ operator+ [1/3]

Matrix operator+	(	const FloatType	x,
		const Matrix &	m1 )

friend

References addition, and Matrix().

◆ operator+ [2/3]

Matrix operator+	(	const Matrix &	m1,
		const FloatType	x )

friend

References addition, and Matrix().

◆ operator+ [3/3]

Matrix operator+	(	const Matrix &	m1,
		const Matrix &	m2 )

friend

References addition, and Matrix().

◆ operator- [1/4]

Matrix operator-	(	const FloatType	x,
		const Matrix &	m1 )

friend

References Matrix(), and substraction.

◆ operator- [2/4]

Matrix operator- ( const Matrix & m )

friend

References Matrix(), and opposite().

◆ operator- [3/4]

Matrix operator-	(	const Matrix &	m1,
		const FloatType	x )

friend

References Matrix(), and substraction.

◆ operator- [4/4]

Matrix operator-	(	const Matrix &	m1,
		const Matrix &	m2 )

friend

References Matrix(), and substraction.

◆ operator/ [1/2]

Matrix operator/	(	const FloatType	x,
		const Matrix &	m1 )

friend

References division, and Matrix().

◆ operator/ [2/2]

Matrix operator/	(	const Matrix &	m1,
		const FloatType	x )

friend

References division, and Matrix().

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		const Matrix &	m1 )

friend

References Matrix(), and matrix.

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		Matrix &	v1 )

friend

References Matrix(), and matrix.

◆ substraction [1/2]

Matrix & substraction	(	const Matrix &	A,
		const FloatType	x,
		Matrix &	C )

friend

References Matrix(), and substraction.

◆ substraction [2/2]

Matrix & substraction	(	const Matrix &	A,
		const Matrix &	B,
		Matrix &	C )

friend

References Matrix(), and substraction.

Referenced by operator-, operator-, operator-, substraction(), substraction, substraction, and substraction().

◆ Vector

friend class Vector

friend

References Vector.

Referenced by dampedInverse(), dampedInverse(), maal::boost::MatrixSvd::dampedInverse(), getDiagonal(), getDiagonal(), multiply, multiply(), multiply(), operator*, operator*, pseudoInverse(), pseudoInverse(), maal::boost::MatrixSvd::pseudoInverse(), setDiagonal(), and Vector.

Member Data Documentation

◆ AUTORESIZE

const bool maal::boost::Matrix::AUTORESIZE = true

static

Referenced by _resize(), _resizeInv(), _resizeProd(), _resizeProd(), and autoresize().

◆ CHECKRESIZE

const bool maal::boost::Matrix::CHECKRESIZE = true

static

Referenced by _checksize(), _checksize(), _checksizeProd(), _checksizeProd(), _checksizeProdVerb(), _checksizeProdVerb(), _checksizeSquare(), _checksizeSquareVerb(), _checksizeVerb(), and _checksizeVerb().

◆ dynamicMatrix

InternalMatrix* maal::boost::Matrix::dynamicMatrix

Referenced by Matrix(), Matrix(), Matrix(), and ~Matrix().

◆ matrix

InternalMatrix& maal::boost::Matrix::matrix

◆ proprio

bool maal::boost::Matrix::proprio

Referenced by Matrix(), Matrix(), and ~Matrix().

◆ staticMatrix

InternalMatrix maal::boost::Matrix::staticMatrix

Referenced by Matrix(), Matrix(), and Matrix().

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Operators

Operator Functions ExE->E

Autoresize internal

Detailed Description

Member Typedef Documentation

◆ InternalMatrix

Constructor & Destructor Documentation

◆ Matrix() [1/3]

◆ Matrix() [2/3]

◆ Matrix() [3/3]

◆ ~Matrix()

Member Function Documentation

◆ _checksize() [1/2]

◆ _checksize() [2/2]

◆ _checksizeProd() [1/2]

◆ _checksizeProd() [2/2]

◆ _checksizeProdVerb() [1/2]

◆ _checksizeProdVerb() [2/2]

◆ _checksizeSquare()

◆ _checksizeSquareVerb()

◆ _checksizeVerb() [1/2]

◆ _checksizeVerb() [2/2]

◆ _resize()

◆ _resizeInv()

◆ _resizeProd() [1/2]

◆ _resizeProd() [2/2]

◆ accessToMotherLib() [1/2]

◆ accessToMotherLib() [2/2]

◆ addition() [1/4]

◆ addition() [2/4]

◆ addition() [3/4]

◆ addition() [4/4]

◆ autoresize()

◆ dampedInverse() [1/2]

◆ dampedInverse() [2/2]

◆ datablock() [1/2]

◆ datablock() [2/2]

◆ determinant()

◆ division() [1/2]

◆ division() [2/2]

◆ elementAt() [1/4]

◆ elementAt() [2/4]

◆ elementAt() [3/4]

◆ elementAt() [4/4]

◆ extract() [1/2]

◆ extract() [2/2]

◆ fill()

◆ getDiagonal() [1/2]

◆ getDiagonal() [2/2]

◆ initFromMotherLib()

◆ inverse() [1/2]

◆ inverse() [2/2]

◆ juxtaposeMatrix() [1/2]

◆ juxtaposeMatrix() [2/2]

◆ max()

◆ min()

◆ multiply() [1/6]

◆ multiply() [2/6]

◆ multiply() [3/6]

◆ multiply() [4/6]

◆ multiply() [5/6]

◆ multiply() [6/6]

◆ nbCols()

◆ nbRows()

◆ norm()

◆ norm1()

◆ normInfty()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+=()

◆ operator-=()

◆ operator=()