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

The parameters for the class qrDecomposition. More...

#include <ltiQrDecomposition.h>

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

[legend]

Collaboration diagram for lti::qrDecomposition< 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
bool	useLapack
int	performanceTweakThresholdForTranspose

---

Detailed Description

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

The parameters for the class qrDecomposition.

---

Constructor & Destructor Documentation

template<class T >

lti::qrDecomposition< T >::parameters::parameters

(

void

)

[inline]

Default constructor.

Reimplemented from lti::linearAlgebraFunctor::parameters.

References _LTI_PERFORMANCE_QR_DECOMPOSITION.

template<class T >

lti::qrDecomposition< T >::parameters::parameters

(

const parameters &

other

)

[inline]

Copy constructor.

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::qrDecomposition< T >::copy().

template<class T >

lti::qrDecomposition< T >::parameters::~parameters

(

)

[inline, virtual]

Destructor.

Reimplemented from lti::linearAlgebraFunctor::parameters.

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

Returns a pointer to a clone of the parameters.

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T >

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

template<class T >

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

(

void

)

const [inline, virtual]

Returns name of this type.

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T >

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

template<class T >

virtual bool lti::qrDecomposition< 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::functor::read(), lti::ioHandler::readBegin(), and lti::ioHandler::readEnd().

template<class T >

virtual bool lti::qrDecomposition< 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::functor::write(), lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

int lti::qrDecomposition< T >::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 isues, the algorithm works a lot faster especially for large matrices. Both, collumns 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: _LTI_PERFORMANCE_QR_DECOMPOSITION in ltiPerformanceConfig.h

template<class T >

bool lti::qrDecomposition< T >::parameters::useLapack

specifies if the lapack routine is used (if available) for qr-decomposition.

If LAPACK is not used or not available, A must be of full rang!

Default: true

---

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

• ltiQrDecomposition.h