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

the parameters for the class entropyFunctor More...

#include <ltiEntropyFunctor.h>

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

[legend]

Collaboration diagram for lti::entropyFunctor< 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)
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	rowWise
bool	normalize

---

Detailed Description

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

the parameters for the class entropyFunctor

---

Constructor & Destructor Documentation

template<class T >

lti::entropyFunctor< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::statisticsFunctor::parameters.

References lti::entropyFunctor< T >::parameters::normalize, and lti::entropyFunctor< T >::parameters::rowWise.

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

template<class T >

lti::entropyFunctor< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::statisticsFunctor::parameters.

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

template<class T >

lti::entropyFunctor< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::statisticsFunctor::parameters.

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::statisticsFunctor::parameters.

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

template<class T >

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

References lti::statisticsFunctor::parameters::copy(), lti::entropyFunctor< T >::parameters::normalize, and lti::entropyFunctor< T >::parameters::rowWise.

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

template<class T >

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

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::statisticsFunctor::parameters.

template<class T >

virtual bool lti::entropyFunctor< 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::functor::parameters.

References lti::entropyFunctor< T >::parameters::normalize, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::entropyFunctor< T >::parameters::rowWise.

template<class T >

virtual bool lti::entropyFunctor< 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::functor::parameters.

References lti::entropyFunctor< T >::parameters::normalize, lti::entropyFunctor< T >::parameters::rowWise, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T >

bool lti::entropyFunctor< T >::parameters::normalize

if false, it will be assume that the matrices or vectors are already normalized, and can be considered directly as probability distributions (which sum is 1.0).

If true, the vectors and matrices will be "normalized" first, in an efficient way. Default value: false

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

template<class T >

bool lti::entropyFunctor< T >::parameters::rowWise

If this flag is true, the entropy computation will be row-wise, i.e.

the result will contain the entropy of the rows. This is much faster than column-wise, since data do not have to be copied. Default value: true

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

---

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

• ltiEntropyFunctor.h