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

the parameters for the class generalizedEigenSystem More...

#include <ltiGeneralizedEigenSystem.h>

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

[legend]

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

[legend]

List of all members.

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
int	dimensions

---

Detailed Description

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

the parameters for the class generalizedEigenSystem

---

Constructor & Destructor Documentation

template<class T >

lti::generalizedEigenSystem< T >::parameters::parameters

(

void

)

[inline]

default constructor.

Set sort to true.

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

Reimplemented in lti::fastGeneralizedEigenSystem< T >::parameters.

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

template<class T >

lti::generalizedEigenSystem< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

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

Reimplemented in lti::fastGeneralizedEigenSystem< T >::parameters.

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

template<class T >

lti::generalizedEigenSystem< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

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

Reimplemented in lti::fastGeneralizedEigenSystem< T >::parameters.

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

template<class T >

parameters& lti::generalizedEigenSystem< 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::eigenSystem< T >::parameters.

Reimplemented in lti::fastGeneralizedEigenSystem< T >::parameters.

References lti::functor::parameters::copy(), and lti::generalizedEigenSystem< T >::parameters::dimensions.

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

template<class T >

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

(

void

)

const [inline, virtual]

returns name of this type

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

Reimplemented in lti::fastGeneralizedEigenSystem< T >::parameters.

template<class T >

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

template<class T >

virtual bool lti::generalizedEigenSystem< 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::generalizedEigenSystem< T >::parameters::dimensions, lti::ioHandler::readBegin(), and lti::ioHandler::readEnd().

template<class T >

virtual bool lti::generalizedEigenSystem< 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::generalizedEigenSystem< T >::parameters::dimensions, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

int lti::generalizedEigenSystem< 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 fastGeneralizedEigenSystem 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::generalizedEigenSystem< T >::parameters::copy(), lti::generalizedEigenSystem< T >::parameters::read(), and lti::generalizedEigenSystem< T >::parameters::write().

---

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

• ltiGeneralizedEigenSystem.h