lti::serialStatsFunctor< T, U >::parameters Class Reference

the parameters for the class meansFunctor More...

#include <ltiSerialStatsFunctor.h>

Inheritance diagram for lti::serialStatsFunctor< T, U >::parameters:

[legend]

Collaboration diagram for lti::serialStatsFunctor< T, U >::parameters:

[legend]

List of all members.

Public Types
enum	eVarianceType { Empirical = 0, Maxlikely = 1 }
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
eVarianceType	type

---

Detailed Description

template<class T, class U = T>
class lti::serialStatsFunctor< T, U >::parameters

the parameters for the class meansFunctor

---

Member Enumeration Documentation

template<class T, class U = T>

enum lti::serialStatsFunctor::parameters::eVarianceType

Type of the variance.

Enumerator:

Empirical	Empirical.
Maxlikely	Maxlikely.

---

Constructor & Destructor Documentation

template<class T, class U = T>

lti::serialStatsFunctor< T, U >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::statisticsFunctor::parameters.

References lti::serialStatsFunctor< T, U >::parameters::Empirical, and lti::serialStatsFunctor< T, U >::parameters::type.

Referenced by lti::serialStatsFunctor< T, U >::parameters::clone().

template<class T, class U = T>

lti::serialStatsFunctor< T, U >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::statisticsFunctor::parameters.

References lti::serialStatsFunctor< T, U >::parameters::copy().

template<class T, class U = T>

lti::serialStatsFunctor< T, U >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::statisticsFunctor::parameters.

---

Member Function Documentation

template<class T, class U = T>

virtual functor::parameters* lti::serialStatsFunctor< T, U >::parameters::clone

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::statisticsFunctor::parameters.

References lti::serialStatsFunctor< T, U >::parameters::parameters().

template<class T, class U = T>

parameters& lti::serialStatsFunctor< T, U >::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(), and lti::serialStatsFunctor< T, U >::parameters::type.

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

template<class T, class U = T>

const char* lti::serialStatsFunctor< T, U >::parameters::getTypeName

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::statisticsFunctor::parameters.

template<class T, class U = T>

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

template<class T, class U = T>

virtual bool lti::serialStatsFunctor< T, U >::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::functor::parameters.

References lti::serialStatsFunctor< T, U >::parameters::Empirical, lti::serialStatsFunctor< T, U >::parameters::Maxlikely, lti::ioHandler::readBegin(), lti::ioHandler::readEnd(), and lti::serialStatsFunctor< T, U >::parameters::type.

template<class T, class U = T>

virtual bool lti::serialStatsFunctor< T, U >::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::serialStatsFunctor< T, U >::parameters::Empirical, lti::serialStatsFunctor< T, U >::parameters::type, lti::ioHandler::writeBegin(), and lti::ioHandler::writeEnd().

---

Member Data Documentation

template<class T, class U = T>

eVarianceType lti::serialStatsFunctor< T, U >::parameters::type

The type of the variance computation.

If type == empirical, the empirical variance or covariance matrix is computed (division by number of samples minus 1), otherwise, the maximum likelihood estimator is computed (division by number of samples). The default is empirical.

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

---

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

• ltiSerialStatsFunctor.h