cvr::svd::svd::helper< T > Class Template Reference

Helper class. More...

#include <cvrSVD.h>

Inheritance diagram for cvr::svd::svd::helper< T >:

[legend]

Collaboration diagram for cvr::svd::svd::helper< T >:

[legend]

List of all members.

Public Member Functions
	helper (const parameters &par)
bool	decomposition (const matrix< T > &src, matrix< T > &u, vector< T > &w, matrix< T > &v) const
bool	decomposition (matrix< T > &src, vector< T > &w, matrix< T > &v) const

---

Detailed Description

template<typename T>
class cvr::svd::helper< T >

Helper class.

---

Constructor & Destructor Documentation

template<typename T >

cvr::svd::svd::helper< T >::helper

(

const parameters &

par

)

The only constructor expects a parameter object.

---

Member Function Documentation

template<typename T >

bool cvr::svd::svd::helper< T >::decomposition	(	matrix< T > &	src,
		vector< T > &	w,
		matrix< T > &	v
	)			const

On-Place version of Singular Value Decomposition.

Singular Value

Decomposition means that a m*n-matrix A is decomposed into three matrices U,W,V, such that A = U*W*V'. U is m*n, W is a diagonal matrix with n elements (which is implemented as vector), V is a n*n-matrix. Note that the function returns V, not V'.

Parameters:

	src	matrix<T> with the source matrix, will also contain the U matrix after the function has returned. If src is a m*n matrix, U will also be of size m*n
	w	vector<T> with the singular values, sorted descendingly The elements of this vector constitute the diagonal of the W matrix.
	v	the V matrix

Returns:

true is the decomposition was successfull, false if an error occured

template<typename T >

bool cvr::svd::svd::helper< T >::decomposition	(	const matrix< T > &	src,
		matrix< T > &	u,
		vector< T > &	w,
		matrix< T > &	v
	)			const

On-Copy version of Singular Value Decomposition.

Singular Value

Decomposition means that a m*n-matrix A is decomposed into three matrices U,W,V, such that A = U*W*V'. U is m*n, W is a diagonal matrix with n elements (which is implemented as vector), V is a n*n-matrix. Note that the function returns V, not V'.

Parameters:

	src	matrix<T> with the source matrix, will also contain the U matrix after the function has returned. If src is a m*n matrix, U will also be of size m*n
	w	vector<T> with the singular values, sorted descendingly The elements of this vector constitute the diagonal of the W matrix.
	v	the V matrix

Returns:

true is the decomposition was successfull, false if an error occured

---

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

• cvrSVD.h