cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters Class Reference

eigenSystem parameter class More...

#include <cvrSymmetricEigenSystem.h>

Inheritance diagram for cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters:

[legend]

Collaboration diagram for cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
parameters &	copy (const parameters &other)
const std::string &	name () const
virtual parameters *	clone () const
virtual parameters *	newInstance () 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

---

Detailed Description

template<typename T>
class cvr::symmetricEigenSystem< T >::parameters

eigenSystem parameter class

---

Constructor & Destructor Documentation

template<typename T >

cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::parameters

(

)

default constructor

Reimplemented from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T >

cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::parameters

(

const parameters &

other

)

copy constructor

Reimplemented from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

---

Member Function Documentation

template<typename T >

virtual parameters* cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::clone

(

)

const [virtual]

returns a pointer to a clone of the parameters.

Reimplemented from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T >

parameters& cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::copy

(

const parameters &

other

)

copy member.

Reimplemented from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T >

const std::string& cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::name

(

)

const [virtual]

Returns the name of this class.

Reimplemented from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T >

virtual parameters* cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::newInstance

(

)

const [virtual]

returns a pointer to a clone of the parameters.

Reimplemented from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T >

virtual bool cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[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 cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T >

virtual bool cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [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 cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

---

Member Data Documentation

template<typename T >

int cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::dimensions

Mumber of dimensions calculated.

If set to zero, then 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)

template<typename T >

bool cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters::sort

If true, the eigenvalues and corresponding eigenvectors will be sorted in decreasing order of the eigenvalues.

For complex-valued matrices a complex number will be considered "greater than" another one if its real part is greater, or, if both real components are identical, if its imaginary part is greater.

Default value: false

---

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

• cvrSymmetricEigenSystem.h