lti::triangularMatrixType Class Reference

This is a helper class that defines the enum eTriangularType and has one member triangularType of that type. More...

#include <ltiTriangularMatrixType.h>

Inheritance diagram for lti::triangularMatrixType:

[legend]

Collaboration diagram for lti::triangularMatrixType:

[legend]

List of all members.

Public Types
enum	eTriangularType { Upper, Lower }
Public Member Functions
const char *	getTypeName () const
triangularMatrixType &	copy (const triangularMatrixType &other)
triangularMatrixType &	operator= (const triangularMatrixType &other)
bool	write (ioHandler &handler, const bool complete=true) const
bool	read (ioHandler &handler, const bool complete=true)
Public Attributes
eTriangularType	triangularType

---

Detailed Description

This is a helper class that defines the enum eTriangularType and has one member triangularType of that type.

It is inherited by the parameter classes of functors that work on regular matrices that are triangular by definition. The triangular type determines whether such a matrix is lower or upper triangular.

---

Member Enumeration Documentation

enum lti::triangularMatrixType::eTriangularType

A triangular matrix can have its values above or below the main diagonal which is called upper or lower triangular matrix, respectively.

Enumerator:

Upper	the data matrix is upper triangular
Lower	the data matrix is lower triangular

---

Member Function Documentation

triangularMatrixType& lti::triangularMatrixType::copy

(

const triangularMatrixType &

other

)

copy data of "other" functor.

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::ioObject.

const char* lti::triangularMatrixType::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::ioObject.

Reimplemented in lti::backSubstitution< T >::parameters, lti::choleskyDecomposition< T >::parameters, and lti::forwardSubstitution< T >::parameters.

triangularMatrixType& lti::triangularMatrixType::operator=

(

const triangularMatrixType &

other

)

alias for copy member

Parameters:

other

the functor to be copied

Returns:

a reference to this functor object

Reimplemented from lti::ioObject.

bool lti::triangularMatrixType::read	(	ioHandler &	handler,
		const bool	complete = true
	)			[virtual]

read the data 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::ioObject.

Reimplemented in lti::backSubstitution< T >::parameters, lti::choleskyDecomposition< T >::parameters, and lti::forwardSubstitution< T >::parameters.

bool lti::triangularMatrixType::write	(	ioHandler &	handler,
		const bool	complete = true
	)			const [virtual]

write the data 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::ioObject.

Reimplemented in lti::backSubstitution< T >::parameters, lti::choleskyDecomposition< T >::parameters, and lti::forwardSubstitution< T >::parameters.

---

Member Data Documentation

eTriangularType lti::triangularMatrixType::triangularType

Sets whether a matrix that is triangular by defintion is upper or lower triangular.

Referenced by lti::forwardSubstitution< T >::parameters::parameters(), lti::choleskyDecomposition< T >::parameters::parameters(), and lti::backSubstitution< T >::parameters::parameters().

---

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

• ltiTriangularMatrixType.h