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

the parameters for the class meansFunctor More...

#include <ltiMeansFunctor.h>

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

[legend]

Collaboration diagram for lti::meansFunctor< 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
Public Attributes
bool	rowWise
bool	geometric

---

Detailed Description

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

the parameters for the class meansFunctor

---

Constructor & Destructor Documentation

template<class T >

lti::meansFunctor< T >::parameters::parameters

(

void

)

[inline]

default constructor

Reimplemented from lti::statisticsFunctor::parameters.

References lti::meansFunctor< T >::parameters::geometric, and lti::meansFunctor< T >::parameters::rowWise.

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

template<class T >

lti::meansFunctor< T >::parameters::parameters

(

const parameters &

other

)

[inline]

copy constructor

Parameters:

other

the parameters object to be copied

Reimplemented from lti::statisticsFunctor::parameters.

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

template<class T >

lti::meansFunctor< T >::parameters::~parameters

(

)

[inline, virtual]

destructor

Reimplemented from lti::statisticsFunctor::parameters.

---

Member Function Documentation

template<class T >

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

(

)

const [inline, virtual]

returns a pointer to a clone of the parameters

Reimplemented from lti::statisticsFunctor::parameters.

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

template<class T >

parameters& lti::meansFunctor< 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::meansFunctor< T >::parameters::geometric, and lti::meansFunctor< T >::parameters::rowWise.

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

template<class T >

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

(

void

)

const [inline, virtual]

returns name of this type

Reimplemented from lti::statisticsFunctor::parameters.

---

Member Data Documentation

template<class T >

bool lti::meansFunctor< T >::parameters::geometric

If this flag is true, the functor will compute the geometric mean of the elements, i.e.

pow(e1*e2*...*en,1/n)

Default value: false

Referenced by lti::meansFunctor< T >::parameters::copy(), and lti::meansFunctor< T >::parameters::parameters().

template<class T >

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

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

the result will contain a sum of the rows. This is much faster than column-wise, since data do not have to be copied.

Default value: true

Referenced by lti::meansFunctor< T >::parameters::copy(), and lti::meansFunctor< T >::parameters::parameters().

---

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

• ltiMeansFunctor.h