LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::eigenSystem< T > Class Template Reference

eigenSystem functor. More...

#include <ltiEigenSystem.h>

Inheritance diagram for lti::eigenSystem< T >:
Inheritance graph
[legend]
Collaboration diagram for lti::eigenSystem< T >:
Collaboration graph
[legend]

List of all members.

Classes

class  parameters
 eigenSystem parameter class More...

Public Member Functions

 eigenSystem ()
 eigenSystem (const parameters &theParams)
 eigenSystem (const bool theSort)
virtual ~eigenSystem ()
const parametersgetParameters () const
virtual bool apply (const matrix< T > &theMatrix, vector< T > &eigenvalues, matrix< T > &eigenvectors) const =0
virtual const char * getTypeName () const

Detailed Description

template<class T>
class lti::eigenSystem< T >

eigenSystem functor.

Base class for Eigenvalue and Eigenvector computation functors.

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!


Constructor & Destructor Documentation

template<class T>
lti::eigenSystem< T >::eigenSystem (  )  [inline]

default constructor

template<class T>
lti::eigenSystem< T >::eigenSystem ( const parameters theParams  ) 

constructor, sets the parameters

template<class T>
lti::eigenSystem< T >::eigenSystem ( const bool  theSort  ) 

constructor, sets the parameters

template<class T>
virtual lti::eigenSystem< T >::~eigenSystem (  )  [inline, virtual]

destructor


Member Function Documentation

template<class T>
virtual bool lti::eigenSystem< T >::apply ( const matrix< T > &  theMatrix,
vector< T > &  eigenvalues,
matrix< T > &  eigenvectors 
) const [pure virtual]

onCopy version of apply.

Parameters:
theMatrix matrix to be transformed
eigenvalues elements will contain the eigenvalues
eigenvectors columns will contain the eigenvectors corresponding to the eigenvalues
Returns:
bool true if successful, false otherwise.

Implemented in lti::jacobi< T >, lti::fastEigenSystem< T >, lti::generalEigenVectors< T >, and lti::jacobi< double >.

template<class T>
const parameters& lti::eigenSystem< T >::getParameters (  )  const
template<class T>
virtual const char* lti::eigenSystem< T >::getTypeName ( void   )  const [inline, virtual]

returns the name of this type

Reimplemented from lti::linearAlgebraFunctor.

Reimplemented in lti::jacobi< T >, lti::fastEigenSystem< T >, lti::generalEigenVectors< T >, and lti::jacobi< double >.


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

Generated on Sat Apr 10 15:28:15 2010 for LTI-Lib by Doxygen 1.6.1