Milena (Olena)  User documentation 2.0a Id
 All Classes Namespaces Functions Variables Typedefs Enumerator Groups Pages
mln::accu::stat::mean< T, S, M > Struct Template Reference

Generic mean accumulator class. More...

#include <mean.hh>

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

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.
 
void take_as_init (const T &t)
 Take as initialization the value 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.

Definition at line 119 of file accu/stat/mean.hh.

Member Function Documentation

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

Get the cardinality.

Definition at line 242 of file accu/stat/mean.hh.

References mln::accu::stat::mean< T, S, M >::to_result().

template<typename T , typename S , typename M >
void mean< T, S, M >::init ( )
inline

Manipulators.

Definition at line 173 of file accu/stat/mean.hh.

template<typename T , typename S , typename M >
bool mean< T, S, M >::is_valid ( ) const
inline

Check whether this accu is able to return a result.

Always true here.

Definition at line 234 of file accu/stat/mean.hh.

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

Get the sum of values.

Definition at line 251 of file accu/stat/mean.hh.

References mln::accu::stat::mean< T, S, M >::to_result().

void mln::Accumulator< mean< T, S, M > >::take_as_init ( const T &  t)
inherited

Take as initialization the value t.

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

void mln::Accumulator< mean< T, S, M > >::take_n_times ( unsigned  n,
const T &  t 
)
inherited

Take n times the value t.

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

template<typename T , typename S , typename M >
M mean< T, S, M >::to_result ( ) const
inline

Get the value of the accumulator.

Definition at line 216 of file accu/stat/mean.hh.

Referenced by mln::accu::stat::mean< T, S, M >::count(), and mln::accu::stat::mean< T, S, M >::sum().