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

parameter class for fastGeneralizedEigenSystem More...

#include <ltiFastGeneralizedEigenSystem.h>

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

[legend]

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

[legend]

List of all members.

Public Types
enum	eProblemType { Type1 = 1, Type2, Type3 }
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
eProblemType	problemType
bool	useDC

---

Detailed Description

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

parameter class for fastGeneralizedEigenSystem

---

Member Enumeration Documentation

template<class T >

enum lti::fastGeneralizedEigenSystem::parameters::eProblemType

Defines different problem types for the generalized eigen system.

Enumerator:

Type1	A*x = lambda*B*x
Type2	A*B*x = lambda*x
Type3	B*A*x = lambda*x

---

Constructor & Destructor Documentation

template<class T >

lti::fastGeneralizedEigenSystem< T >::parameters::parameters

(

void

)

[inline]

default constructor

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

References lti::fastGeneralizedEigenSystem< T >::parameters::problemType, and lti::fastGeneralizedEigenSystem< T >::parameters::Type1.

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

template<class T >

lti::fastGeneralizedEigenSystem< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

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

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

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters.

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

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

template<class T >

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

(

const parameters &

other

)

[inline]

copy member.

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

References lti::fastGeneralizedEigenSystem< T >::parameters::problemType, and lti::fastGeneralizedEigenSystem< T >::parameters::useDC.

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

template<class T >

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

(

void

)

const [inline, virtual]

returns the name of this type

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

---

Member Data Documentation

template<class T >

eProblemType lti::fastGeneralizedEigenSystem< T >::parameters::problemType

the problem type to be solved.

Default is Type1.

Referenced by lti::fastGeneralizedEigenSystem< T >::parameters::copy(), and lti::fastGeneralizedEigenSystem< T >::parameters::parameters().

template<class T >

bool lti::fastGeneralizedEigenSystem< T >::parameters::useDC

If true the divide-and-conquer method for calculating the SVD is used.

This is generally faster, especially on large matrices. However, it uses more temporary memory than the simple method. Thus, if the computation fails due to memory problems setting this parameter to false might solve the problem. Default is true.

Note: If dimensions is unequal to zero, ie not all eigenvalues/vectors are calculated this option is not available and internally set to false.

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

---

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

• ltiFastGeneralizedEigenSystem.h