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

parameters class for lti::matrixInversion functor More...

#include <ltiMatrixInversion.h>

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

[legend]

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

[legend]

List of all members.

Public Types
enum	algorithmType { LUD = 0, SVD = 1 }
Public Member Functions
	parameters (void)
	parameters (const parameters &other)
	~parameters ()
const char *	getTypeName () const
parameters &	copy (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
algorithmType	method

Detailed Description

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

parameters class for lti::matrixInversion functor

Member Enumeration Documentation

template<class T>

enum lti::matrixInversion::parameters::algorithmType

Available algorithms for matrix inversion.

Enumerator:

LUD	LU-Decomposition.
SVD	Singular Value Decomposition.

Constructor & Destructor Documentation

template<class T>

lti::matrixInversion< T >::parameters::parameters ( void ) [inline]

Default constructor.

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::matrixInversion< T >::parameters::LUD, and lti::matrixInversion< T >::parameters::method.

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

template<class T>

lti::matrixInversion< T >::parameters::parameters ( const parameters & other ) [inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T>

lti::matrixInversion< T >::parameters::~parameters ( ) [inline, virtual]

destructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

Member Function Documentation

template<class T>

virtual functor::parameters* lti::matrixInversion< T >::parameters::clone ( ) const [inline, virtual]

return a cloned instance of this one.

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T>

parameters& lti::matrixInversion< T >::parameters::copy ( const parameters & other ) [inline]

copy member

Parameters:

other

the parameters object to be copied

Returns:: a reference to this object

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::functor::parameters::copy(), and lti::matrixInversion< T >::parameters::method.

Referenced by lti::matrixInversion< T >::parameters::parameters().

template<class T>

const char* lti::matrixInversion< T >::parameters::getTypeName ( void ) const [inline, virtual]

returns name of this type

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T>

virtual bool lti::matrixInversion< 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 read, otherwise only the data block will be read.

Returns:: true if write was successful

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::matrixInversion< T >::parameters::LUD, lti::matrixInversion< T >::parameters::method, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::matrixInversion< T >::parameters::SVD.

template<class T>

virtual bool lti::matrixInversion< 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.