mln::accu::stat::mean< T, S, M > Struct Template Reference
[On values]

Generic mean accumulator class. More...

#include <mean.hh>

Inherits mln::accu::internal::base< M, mln::accu::stat::mean< T, S, M > >.

List of all members.

Public Member Functions

accu::math::count< T >::result count () const
 Get the cardinality.
bool is_valid () const
 Check whether this accu is able to return a result.
accu::math::sum< T >::result sum () const
 Get the sum of values.
template<typename T>
void take_as_init (const T &t)
 Take as initialization the value t.
template<typename T>
void take_n_times (unsigned n, const T &t)
 Take n times the value t.
to_result () const
 Get the value of the accumulator.
void init ()
 Manipulators.


Detailed Description

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
struct mln::accu::stat::mean< T, S, M >

Generic mean accumulator class.

Parameter T is the type of values that we sum. Parameter S is the type to store the sum of values; the default type of S is the summation type (property) of T. Parameter M is the type of the mean value; the default type of M is S.


Member Function Documentation

template<typename T, typename S, typename M>
accu::math::count< T >::result mln::accu::stat::mean< T, S, M >::count (  )  const [inline]

Get the cardinality.

template<typename T, typename S, typename M>
void mln::accu::stat::mean< T, S, M >::init (  )  [inline]

Manipulators.

template<typename T, typename S, typename M>
bool mln::accu::stat::mean< T, S, M >::is_valid (  )  const [inline]

Check whether this accu is able to return a result.

Always true here.

template<typename T, typename S, typename M>
accu::math::sum< T >::result mln::accu::stat::mean< T, S, M >::sum (  )  const [inline]

Get the sum of values.

template<typename E>
template<typename T>
void mln::Accumulator< E >::take_as_init ( const T &  t  )  [inline, inherited]

Take as initialization the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

Reimplemented in mln::accu::stat::variance< T, S, R >.

References mln::mln_exact().

template<typename E>
template<typename T>
void mln::Accumulator< E >::take_n_times ( unsigned  n,
const T &  t 
) [inline, inherited]

Take n times the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

References mln::mln_exact().

template<typename T, typename S, typename M>
M mln::accu::stat::mean< T, S, M >::to_result (  )  const [inline]

Get the value of the accumulator.


Generated on Thu Sep 9 19:31:41 2010 for Milena (Olena) by  doxygen 1.5.6