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

The parameters for the class qrDecomposition. More...

#include <cvrQrDecomposition.h>

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

[legend]

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

[legend]

List of all members.

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

---

Detailed Description

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

The parameters for the class qrDecomposition.

---

Constructor & Destructor Documentation

template<typename T>

cvr::qrDecomposition< T >::qrDecomposition::parameters::parameters

(

)

Default constructor.

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

template<typename T>

cvr::qrDecomposition< T >::qrDecomposition::parameters::parameters

(

const parameters &

other

)

Copy constructor.

Parameters:

other

the parameters object to be copied

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

template<typename T>

cvr::qrDecomposition< T >::qrDecomposition::parameters::~parameters

(

)

[virtual]

Destructor.

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

---

Member Function Documentation

template<typename T>

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

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

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

template<typename T>

parameters& cvr::qrDecomposition< T >::qrDecomposition::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 from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T>

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

(

)

const [virtual]

Returns the name of this class.

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

template<typename T>

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

(

)

const [virtual]

Returns a pointer to a clone of the parameters.

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

template<typename T>

parameters& cvr::qrDecomposition< T >::qrDecomposition::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 from cvr::linearAlgebraFunctor::linearAlgebraFunctor::parameters.

template<typename T>

virtual bool cvr::qrDecomposition< T >::qrDecomposition::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::qrDecomposition< T >::qrDecomposition::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::qrDecomposition< T >::qrDecomposition::parameters::performanceTweakThresholdForTranspose

Specifies above which matrix size, the matrix is internally transposed.

This parameter takes only effect if useLapack is false or LAPACK is not available.

Due to memory access issues, the algorithm works a lot faster especially for large matrices.

Both, columns and rows are checked against this value. So a value of 50 means that the matrix must have at least 51 rows and at least 51 columns to be transposed.

Default: _CVR_PERFORMANCE_QR_DECOMPOSITION in cvrPerformanceConfig.h

---

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

• cvrQrDecomposition.h