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

the parameters for the class unifiedSymmetricEigenSystem More...

#include <ltiUnifiedSymmetricEigenSystem.h>

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

[legend]

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

[legend]

List of all members.

Public Types
enum	eEigenSystemType { Jacobi, FastEigenSystem = 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
bool	useRRR
eEigenSystemType	esType

---

Detailed Description

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

the parameters for the class unifiedSymmetricEigenSystem

---

Member Enumeration Documentation

template<class T >

enum lti::unifiedSymmetricEigenSystem::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:

Jacobi	use jacobi
FastEigenSystem	use fastEigenSystem

---

Constructor & Destructor Documentation

template<class T >

lti::unifiedSymmetricEigenSystem< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::unifiedSymmetricEigenSystem< T >::parameters::dimensions, lti::unifiedSymmetricEigenSystem< T >::parameters::esType, lti::unifiedSymmetricEigenSystem< T >::parameters::FastEigenSystem, lti::unifiedSymmetricEigenSystem< T >::parameters::Jacobi, and lti::unifiedSymmetricEigenSystem< T >::parameters::useRRR.

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

template<class T >

lti::unifiedSymmetricEigenSystem< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T >

lti::unifiedSymmetricEigenSystem< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T >

parameters& lti::unifiedSymmetricEigenSystem< 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::unifiedSymmetricEigenSystem< T >::parameters::dimensions, lti::unifiedSymmetricEigenSystem< T >::parameters::esType, and lti::unifiedSymmetricEigenSystem< T >::parameters::useRRR.

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

template<class T >

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

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T >

parameters& lti::unifiedSymmetricEigenSystem< 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::unifiedSymmetricEigenSystem< T >::parameters::copy().

template<class T >

virtual bool lti::unifiedSymmetricEigenSystem< 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::unifiedSymmetricEigenSystem< T >::parameters::dimensions, lti::unifiedSymmetricEigenSystem< T >::parameters::esType, lti::unifiedSymmetricEigenSystem< T >::parameters::FastEigenSystem, lti::unifiedSymmetricEigenSystem< T >::parameters::Jacobi, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::unifiedSymmetricEigenSystem< T >::parameters::useRRR.

template<class T >

virtual bool lti::unifiedSymmetricEigenSystem< 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::unifiedSymmetricEigenSystem< T >::parameters::dimensions, lti::unifiedSymmetricEigenSystem< T >::parameters::esType, lti::unifiedSymmetricEigenSystem< T >::parameters::FastEigenSystem, lti::unifiedSymmetricEigenSystem< T >::parameters::Jacobi, lti::unifiedSymmetricEigenSystem< T >::parameters::useRRR, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

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

The number of eigenvalues/-vectors to be calculated.

If zero all EV are calculated. Default 0.

See also:

• jacobi<T>::parameters::dimensions
• fastEigenSystem<T>::parameters::dimensions

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

template<class T >

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

The eigenSystem given is used.

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

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

template<class T >

bool lti::unifiedSymmetricEigenSystem< 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::unifiedSymmetricEigenSystem< T >::parameters::useRRR

This parameter is used only if esType=FastEigenSystem.

It determines whether the relatively robust representation is used. This can be much faster than the default but might also hang. For this reason:

Default: false

See alse:

• fastEigenSystem<T>::parameters::useRRR;

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

---

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

• ltiUnifiedSymmetricEigenSystem.h