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

the parameters for the class forwardSubstitution More...

#include <ltiForwardSubstitution.h>

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

[legend]

Collaboration diagram for lti::forwardSubstitution< 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
matrix< T >	theMatrix

---

Detailed Description

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

the parameters for the class forwardSubstitution

---

Constructor & Destructor Documentation

template<class T >

lti::forwardSubstitution< T >::parameters::parameters

(

void

)

[inline]

default constructor.

The triangularType is Lower by default.

Reimplemented from lti::linearAlgebraFunctor::parameters.

References lti::triangularMatrixType::Lower, and lti::triangularMatrixType::triangularType.

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

template<class T >

lti::forwardSubstitution< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T >

lti::forwardSubstitution< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::linearAlgebraFunctor::parameters.

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

template<class T >

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

Referenced by lti::forwardSubstitution< T >::parameters::operator=(), and lti::forwardSubstitution< T >::parameters::parameters().

template<class T >

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

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::linearAlgebraFunctor::parameters.

template<class T >

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

template<class T >

virtual bool lti::forwardSubstitution< 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::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::forwardSubstitution< T >::parameters::theMatrix.

template<class T >

virtual bool lti::forwardSubstitution< 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::forwardSubstitution< T >::parameters::theMatrix, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

matrix<T> lti::forwardSubstitution< T >::parameters::theMatrix

The data matrix.

Referenced by lti::forwardSubstitution< T >::parameters::copy(), lti::forwardSubstitution< T >::parameters::read(), and lti::forwardSubstitution< T >::parameters::write().

---

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

• ltiForwardSubstitution.h