lti::jacobi< T >::parameters Class Reference

eigenSystem parameter class More...

#include <ltiEigenSystem.h>

Inheritance diagram for lti::jacobi< T >::parameters:

[legend]

Collaboration diagram for lti::jacobi< T >::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual const char *	getTypeName () const
parameters &	copy (const parameters &other)
virtual functor::parameters *	clone () const
Public Attributes
int	dimensions

---

Detailed Description

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

eigenSystem parameter class

---

Constructor & Destructor Documentation

template<class T>

lti::jacobi< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::eigenSystem< T >::parameters.

Referenced by lti::jacobi< T >::parameters::clone().

template<class T>

lti::jacobi< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Reimplemented from lti::eigenSystem< T >::parameters.

References lti::jacobi< T >::parameters::copy().

---

Member Function Documentation

template<class T>

virtual functor::parameters* lti::jacobi< T >::parameters::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters.

Reimplemented from lti::eigenSystem< T >::parameters.

References lti::jacobi< T >::parameters::parameters().

template<class T>

parameters& lti::jacobi< T >::parameters::copy

(

const parameters &

other

)

[inline]

copy member.

Reimplemented from lti::eigenSystem< T >::parameters.

References lti::jacobi< T >::parameters::dimensions.

Referenced by lti::jacobi< T >::parameters::parameters().

template<class T>

virtual const char* lti::jacobi< T >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns the name of this type

Reimplemented from lti::eigenSystem< T >::parameters.

---

Member Data Documentation

template<class T>

int lti::jacobi< T >::parameters::dimensions

number of dimensions calculated.

The default is zero. In this case, all eigenvectors and eigenvalues are calculated.

This option is only provided for compatibility with the fastEigenSystem functor based on LAPACK, but it does not make (yet) the computation of the eigensolution any faster. It just will cut the already computed complete solution to the desired size!

Default value: 0 (implying all eigenvalues will be computed)

Referenced by lti::jacobi< T >::parameters::copy().

---

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

• ltiEigenSystem.h