cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters Class Reference

The parameters for the linear algebra functors. More...

#include <cvrLinearAlgebraFunctor.h>

Inheritance diagram for cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters:

[legend]

Collaboration diagram for cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters:

[legend]

List of all members.

Public Member Functions
	parameters ()
	parameters (const parameters &other)
virtual	~parameters ()
parameters &	copy (const parameters &other)
parameters &	operator= (const parameters &other)
virtual 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	useLapack

---

Detailed Description

The parameters for the linear algebra functors.

---

Constructor & Destructor Documentation

cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::parameters

(

)

default constructor

Reimplemented from cvr::functor::functor::parameters.

Reimplemented in cvr::decompositionSolution< T >::decompositionSolution::parameters, cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::qrSolution< T >::qrSolution::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::parameters

(

const parameters &

other

)

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from cvr::functor::functor::parameters.

Reimplemented in cvr::decompositionSolution< T >::decompositionSolution::parameters, cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::qrSolution< T >::qrSolution::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

virtual cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::~parameters

(

)

[virtual]

destructor

Reimplemented from cvr::functor::functor::parameters.

Reimplemented in cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, and cvr::svd::svd::parameters.

---

Member Function Documentation

virtual parameters* cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::clone

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

Implements cvr::functor::functor::parameters.

Reimplemented in cvr::decompositionSolution< T >::decompositionSolution::parameters, cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::qrSolution< T >::qrSolution::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

parameters& cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::copy

(

const parameters &

other

)

copy the contents of a parameters object

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented in cvr::decompositionSolution< T >::decompositionSolution::parameters, cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::qrSolution< T >::qrSolution::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

virtual const std::string& cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::name

(

)

const [virtual]

Returns the name of this type.

Implements cvr::functor::functor::parameters.

Reimplemented in cvr::decompositionSolution< T >::decompositionSolution::parameters, cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::qrSolution< T >::qrSolution::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

virtual parameters* cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::newInstance

(

)

const [virtual]

Returns a pointer to a new instance of the parameters.

Implements cvr::functor::functor::parameters.

Reimplemented in cvr::decompositionSolution< T >::decompositionSolution::parameters, cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::qrSolution< T >::qrSolution::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

parameters& cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::operator=

(

const parameters &

other

)

Copy the contents of a parameters object.

Parameters:

other

the parameters object to be copied

Returns:

a reference to this parameters object

Reimplemented in cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, and cvr::svd::svd::parameters.

virtual bool cvr::linearAlgebraFunctor::linearAlgebraFunctor::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::parametersManager::parametersManager::parameters.

Reimplemented in cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

virtual bool cvr::linearAlgebraFunctor::linearAlgebraFunctor::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::parametersManager::parametersManager::parameters.

Reimplemented in cvr::linearLeastSquares::linearLeastSquares::parameters, cvr::luDecomposition< T >::luDecomposition::parameters, cvr::minimizeBasis::minimizeBasis::parameters, cvr::pca< T >::pca::parameters, cvr::qrDecomposition< T >::qrDecomposition::parameters, cvr::svd::svd::parameters, and cvr::symmetricEigenSystem< T >::symmetricEigenSystem::parameters.

---

Member Data Documentation

bool cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters::useLapack

Many linear algebra functors offer (besides the CVR-Lib implementation) to use LAPACK functions for solving a certain problem.

If you have LAPACK installed and configured the CVR-Lib to make use of it (e.g. through changing a config file or by just using autoconf) useLapack==true carries out that implementation.

If a linear algebra functor does not provide a LAPACK version the setting of this parameter has no effect. Such linearAlgebraFunctors should state that fact in their class description.

Since mostly LAPACK methods are faster that those provided in the CVR-Lib the default is true whenever LAPACK was detected and false otherwise. The latter really doesn't have any effect but looks more informative.

Sometimes it can be slower to use LAPACK because it uses column-wise scanning of matrices while the CVR-Lib uses rows. This comes from the predominant orientation in the two programming languages (FORTRAN and C++). Thus, often it is necessary to transpose data before and after using LAPACK. For small problems this might be significant.

Default: true if LAPACK is available, false otherwise

---

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

• cvrLinearAlgebraFunctor.h