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

the parameters for the class More...

#include <ltiSVD.h>

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

[legend]

Collaboration diagram for lti::singularValueDecomp< 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	read (ioHandler &handler, const bool complete=true)
virtual bool	write (ioHandler &handler, const bool complete=true) const
Public Attributes
bool	sort
bool	transposeU
bool	transposeV

---

Detailed Description

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

the parameters for the class

---

Constructor & Destructor Documentation

template<class T>

lti::singularValueDecomp< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

Reimplemented in lti::fastSVD< T >::parameters.

References lti::singularValueDecomp< T >::parameters::transposeU, and lti::singularValueDecomp< T >::parameters::transposeV.

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

template<class T>

lti::singularValueDecomp< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::linearAlgebraFunctor::parameters.

Reimplemented in lti::fastSVD< T >::parameters.

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

template<class T>

lti::singularValueDecomp< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::linearAlgebraFunctor::parameters.

---

Member Function Documentation

template<class T>

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::linearAlgebraFunctor::parameters.

Reimplemented in lti::fastSVD< T >::parameters.

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

template<class T>

parameters& lti::singularValueDecomp< 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.

Reimplemented in lti::fastSVD< T >::parameters.

References lti::functor::parameters::copy(), lti::singularValueDecomp< T >::parameters::transposeU, and lti::singularValueDecomp< T >::parameters::transposeV.

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

template<class T>

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

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::linearAlgebraFunctor::parameters.

Reimplemented in lti::fastSVD< T >::parameters.

template<class T>

parameters& lti::singularValueDecomp< T >::parameters::operator=

(

const parameters &

other

)

[inline]

Assigns the contents of the other object to this object.

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

template<class T>

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

Reimplemented in lti::fastSVD< T >::parameters.

References lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), lti::singularValueDecomp< T >::parameters::transposeU, and lti::singularValueDecomp< T >::parameters::transposeV.

template<class T>

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

Reimplemented in lti::fastSVD< T >::parameters.

References lti::singularValueDecomp< T >::parameters::transposeU, lti::singularValueDecomp< T >::parameters::transposeV, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T>

bool lti::singularValueDecomp< T >::parameters::sort

If true, singular values and corresponding singular vectors are rearranged so that singular values have descending order.

Default is false.

template<class T>

bool lti::singularValueDecomp< T >::parameters::transposeU

Specifies whether U (false) or Ut (true) is returned.

It is faster to return Ut. Default is false, ie U.

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

template<class T>

bool lti::singularValueDecomp< T >::parameters::transposeV

Specifies whether V (false) or Vt (true) is returned.

It is faster to return V. Default is false, ie V.

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

---

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

• ltiSVD.h