lti::jacobi< T > Class Template Reference

jacobi functor. More...

#include <ltiEigenSystem.h>

Inheritance diagram for lti::jacobi< T >:

[legend]

Collaboration diagram for lti::jacobi< T >:

[legend]

List of all members.

Classes
class	parameters
	eigenSystem parameter class More...
Public Member Functions
	jacobi ()
	jacobi (const parameters &params)
virtual bool	apply (const matrix< T > &theMatrix, vector< T > &eigenvalues, matrix< T > &eigenvectors) const
virtual functor *	clone () const
virtual const char *	getTypeName () const
const parameters &	getParameters () const

Detailed Description

template<class T>
class lti::jacobi< T >

jacobi functor.

This functor computes all eigenvalues and eigenvectors of a real _symmetric and square_ matrix using the Jacobi method.

Please note that the eigenvector matrices will contain the eigenvector in the COLUMNS and not in the rows, as could be expected. This avoids the requirement of transposing matrices in eigenvector-based transformations like PCA! All eigenvector functors follows this interface.

Constructor & Destructor Documentation

template<class T>

lti::jacobi< T >::jacobi ( )

default constructor

template<class T>

lti::jacobi< T >::jacobi ( const parameters & params )

default constructor with parameters

Member Function Documentation

template<class T>

virtual bool lti::jacobi< T >::apply	(	const matrix< T > &	theMatrix,
		vector< T > &	eigenvalues,
		matrix< T > &	eigenvectors
	)			const `[virtual]`

onCopy version of apply.

Parameters:

	theMatrix	Real symmetric matrix to be transformed. Only the diagonal and above diagonal elements have to be set.
	eigenvalues	Elements will contain the eigenvalues.
	eigenvectors	Columns will contain the eigenvectors corresponding to the eigenvalues. returns true if successful, false otherwise.