SimTK::FactorSVD Class Reference

Class to compute a singular value decomposition of a matrix. More...

Inheritance diagram for SimTK::FactorSVD:

Public Member Functions
	~FactorSVD ()
	FactorSVD ()
	default constructor More...
	FactorSVD (const FactorSVD &c)
	copy constructor More...
FactorSVD &	operator= (const FactorSVD &rhs)
	copy assign More...
template<class ELT >
	FactorSVD (const Matrix_< ELT > &m)
	constructor More...
template<class ELT >
	FactorSVD (const Matrix_< ELT > &m, float rcond)
	singular value decomposition of a matrix using the specified reciprocal of the condition number rcond More...
template<class ELT >
	FactorSVD (const Matrix_< ELT > &m, double rcond)
	singular value decomposition of a matrix using the specified reciprocal of the condition number rcond More...
template<class ELT >
void	factor (const Matrix_< ELT > &m)
	supply the matrix to do a singular value decomposition More...
template<class ELT >
void	factor (const Matrix_< ELT > &m, float rcond)
	supply the matrix to do a singular value decomposition using the specified reciprocal of the condition number rcond More...
template<class ELT >
void	factor (const Matrix_< ELT > &m, double rcond)
	supply the matrix to do a singular value decomposition using the specified reciprocal of the condition reciprocal of the condition number rcond More...
template<class T >
void	getSingularValuesAndVectors (Vector_< typename CNT< T >::TReal > &values, Matrix_< T > &leftVectors, Matrix_< T > &rightVectors)
	get the singular values and singular vectors of the matrix More...
template<class T >
void	getSingularValues (Vector_< T > &values)
	get just the singular values of the matrix More...
int	getRank ()
	get rank of the matrix More...
template<class ELT >
void	inverse (Matrix_< ELT > &m)
	get inverse of the matrix using singular value decomposition (sometimes called the pseudo inverse) More...
template<class ELT >
void	solve (const Vector_< ELT > &b, Vector_< ELT > &x)
	solve for x given a right hand side vector using the singular value decomposition More...
template<class ELT >
void	solve (const Matrix_< ELT > &b, Matrix_< ELT > &x)
	solve for a set of x vectors given multiple right hand side vectors using the singular value decomposition More...
Public Member Functions inherited from SimTK::Factor
	Factor ()
template<class ELT >
	Factor (Matrix_< ELT > m)
	creates an factorization of a matrix More...
template<class ELT >
void	solve (const Vector_< ELT > &b, Vector_< ELT > &x) const
	solves a single right hand side using a factorization More...
template<class ELT >
void	solve (const Matrix_< ELT > &b, Matrix_< ELT > &x) const
	solves multiple right hand sides using a factorization More...

Protected Attributes
class FactorSVDRepBase *	rep

Detailed Description

Class to compute a singular value decomposition of a matrix.

Constructor & Destructor Documentation

SimTK::FactorSVD::~FactorSVD

(

)

SimTK::FactorSVD::FactorSVD

(

)

default constructor

SimTK::FactorSVD::FactorSVD

(

const FactorSVD &

c

)

copy constructor

template<class ELT >

SimTK::FactorSVD::FactorSVD

(

const Matrix_< ELT > &

m

)

constructor

template<class ELT >

SimTK::FactorSVD::FactorSVD	(	const Matrix_< ELT > &	m,
		float	rcond
	)

singular value decomposition of a matrix using the specified reciprocal of the condition number rcond

template<class ELT >

SimTK::FactorSVD::FactorSVD	(	const Matrix_< ELT > &	m,
		double	rcond
	)

singular value decomposition of a matrix using the specified reciprocal of the condition number rcond

Member Function Documentation

FactorSVD& SimTK::FactorSVD::operator=

(

const FactorSVD &

rhs

)

copy assign

template<class ELT >

void SimTK::FactorSVD::factor

(

const Matrix_< ELT > &

m

)

supply the matrix to do a singular value decomposition

template<class ELT >

void SimTK::FactorSVD::factor	(	const Matrix_< ELT > &	m,
		float	rcond
	)

supply the matrix to do a singular value decomposition using the specified reciprocal of the condition number rcond

template<class ELT >

void SimTK::FactorSVD::factor	(	const Matrix_< ELT > &	m,
		double	rcond
	)

supply the matrix to do a singular value decomposition using the specified reciprocal of the condition reciprocal of the condition number rcond

template<class T >

void SimTK::FactorSVD::getSingularValuesAndVectors	(	Vector_< typename CNT< T >::TReal > &	values,
		Matrix_< T > &	leftVectors,
		Matrix_< T > &	rightVectors
	)

get the singular values and singular vectors of the matrix

template<class T >

void SimTK::FactorSVD::getSingularValues

(

Vector_< T > &

values

)

get just the singular values of the matrix

int SimTK::FactorSVD::getRank

(

)

get rank of the matrix

template<class ELT >

void SimTK::FactorSVD::inverse

(

Matrix_< ELT > &

m

)

get inverse of the matrix using singular value decomposition (sometimes called the pseudo inverse)

template<class ELT >

void SimTK::FactorSVD::solve	(	const Vector_< ELT > &	b,
		Vector_< ELT > &	x
	)

solve for x given a right hand side vector using the singular value decomposition

template<class ELT >

void SimTK::FactorSVD::solve	(	const Matrix_< ELT > &	b,
		Matrix_< ELT > &	x
	)

solve for a set of x vectors given multiple right hand side vectors using the singular value decomposition

Member Data Documentation

class FactorSVDRepBase* SimTK::FactorSVD::rep

protected

---

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

• LinearAlgebra.h