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

the parameters for the class unifiedGeneralizedEigenSystem. More...

#include <ltiUnifiedGeneralizedEigenSystem.h>

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

[legend]

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

[legend]

List of all members.

Public Types
enum	eEigenSystemType { GeneralizedEigenSystem, FastGeneralizedEigenSystem = 10 }
Public Member Functions
	parameters ()
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual functor::parameters *	clone () const
virtual bool	write (ioHandler &handler, const bool complete=true) const
virtual bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
bool	sort
int	dimensions
eEigenSystemType	esType
bool	useDC

---

Detailed Description

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

the parameters for the class unifiedGeneralizedEigenSystem.

Note that the parameter problemType of fastGeneralizedEigenSystem is statically set to Type1 in this functor, which results in the same functionality as that of generalizedEigenSystem. If you need other types use the LAPACK method directly.

---

Member Enumeration Documentation

template<class T >

enum lti::unifiedGeneralizedEigenSystem::parameters::eEigenSystemType

The Eigensystem solution method to use.

Note that functors starting with Fast___ are only available if LAPACK is used. The default is set according to your installation.

Enumerator:

GeneralizedEigenSystem	use generalizedEigenSystem
FastGeneralizedEigenSystem	use fastGeneralizedEigenSystem

---

Constructor & Destructor Documentation

template<class T >

lti::unifiedGeneralizedEigenSystem< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::unifiedGeneralizedEigenSystem< T >::parameters::dimensions, lti::unifiedGeneralizedEigenSystem< T >::parameters::esType, lti::unifiedGeneralizedEigenSystem< T >::parameters::FastGeneralizedEigenSystem, lti::unifiedGeneralizedEigenSystem< T >::parameters::GeneralizedEigenSystem, and lti::unifiedGeneralizedEigenSystem< T >::parameters::useDC.

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

template<class T >

lti::unifiedGeneralizedEigenSystem< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T >

lti::unifiedGeneralizedEigenSystem< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T >

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

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::linearAlgebraFunctor::parameters::copy(), lti::unifiedGeneralizedEigenSystem< T >::parameters::dimensions, and lti::unifiedGeneralizedEigenSystem< T >::parameters::esType.

Referenced by lti::unifiedGeneralizedEigenSystem< T >::parameters::operator=(), and lti::unifiedGeneralizedEigenSystem< T >::parameters::parameters().

template<class T >

const char* lti::unifiedGeneralizedEigenSystem< T >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T >

parameters& lti::unifiedGeneralizedEigenSystem< T >::parameters::operator=

(

const parameters &

other

)

[inline]

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

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

template<class T >

virtual bool lti::unifiedGeneralizedEigenSystem< T >::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[inline, virtual]

read the parameters from the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::unifiedGeneralizedEigenSystem< T >::parameters::dimensions, lti::unifiedGeneralizedEigenSystem< T >::parameters::esType, lti::unifiedGeneralizedEigenSystem< T >::parameters::FastGeneralizedEigenSystem, lti::unifiedGeneralizedEigenSystem< T >::parameters::GeneralizedEigenSystem, lti::ioHandler::readBegin(), and lti::ioHandler::readEnd().

template<class T >

virtual bool lti::unifiedGeneralizedEigenSystem< T >::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [inline, virtual]

write the parameters in the given ioHandler

Parameters:

	handler	the ioHandler to be used
	complete	if true (the default) the enclosing begin/end will be also written, otherwise only the data block will be written.

Returns:

true if write was successful

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::unifiedGeneralizedEigenSystem< T >::parameters::dimensions, lti::unifiedGeneralizedEigenSystem< T >::parameters::esType, lti::unifiedGeneralizedEigenSystem< T >::parameters::FastGeneralizedEigenSystem, lti::unifiedGeneralizedEigenSystem< T >::parameters::GeneralizedEigenSystem, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

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

The number of eigenvalues/-vectors to be calculated.

If zero all EV are calculated. Default 0.

See also:

• generalizedEigenSystem<T>::parameters::dimensions
• fastGeneralizedEigenSystem<T>::parameters::dimensions

Referenced by lti::unifiedGeneralizedEigenSystem< T >::parameters::copy(), lti::unifiedGeneralizedEigenSystem< T >::parameters::parameters(), lti::unifiedGeneralizedEigenSystem< T >::parameters::read(), and lti::unifiedGeneralizedEigenSystem< T >::parameters::write().

template<class T >

eEigenSystemType lti::unifiedGeneralizedEigenSystem< T >::parameters::esType

The eigenSystem given is used.

Note that you cannot use fastGeneralizedEigenSystem if LAPACK is not installed. The default is dependent on the the system configuration: If LAPACK is available, fastGeneralizedEigenSystem is used, otherwise generalizedEigenSystem.

Referenced by lti::unifiedGeneralizedEigenSystem< T >::parameters::copy(), lti::unifiedGeneralizedEigenSystem< T >::parameters::parameters(), lti::unifiedGeneralizedEigenSystem< T >::parameters::read(), and lti::unifiedGeneralizedEigenSystem< T >::parameters::write().

template<class T >

bool lti::unifiedGeneralizedEigenSystem< T >::parameters::sort

If true the eigenvalues and eigenvectors are sorted in descending order.

Default true.

See eigenSystem<T>::parameters::sort.

template<class T >

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

This parameters is used only if esType==FastGeneralizedEigenSystem.

It determines whether the divide and conquer strategy is used or not. Default true.

See fastGeneralizedEigenSystem<T>::parameters::useDC

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

---

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

• ltiUnifiedGeneralizedEigenSystem.h