$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::accu::stat::deviation< T, S, M > Struct Template Reference

#include <mln/accu/stat/deviation.hh>

Public Member Functions

 deviation (const T mean)
bool is_valid () const
 operator M () const
subj_ ()
void take_as_init (const T &t)
void take_as_init_ (const T &t)
void take_n_times (unsigned n, const T &t)
void take_n_times_ (unsigned n, const T &t)
to_result () const
void init ()
void take (const argument &t)
void take (const deviation< T, S, M > &other)

Protected Attributes

accu::math::count< T > count_
mean_
accu::math::sum< typename
mln::value::props< T >::sum, S > 
sum_

Public Types

typedef T argument
typedef Accumulator< void > category
typedef deviation< T, S, M > exact_t
typedef M q_result
typedef M result

Detailed Description

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

Generic standard deviation accumulator class.

Parameter T is the type of values that we sum. Parameter S is the type to store the standard deviation; 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 62 of file deviation.hh.

Constructor & Destructor Documentation

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
mln::accu::stat::deviation< T, S, M >::deviation ( const T  mean)

Member Function Documentation

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
void mln::accu::stat::deviation< T, S, M >::init ( )

Manipulators.

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
bool mln::accu::stat::deviation< T, S, M >::is_valid ( ) const

Check whether this accu is able to return a result.

Always true here.

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
mln::accu::stat::deviation< T, S, M >::operator M ( ) const
M mln::accu::internal::base< M , deviation< T, S, M > >::subj_ ( )
inherited
template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
void mln::accu::stat::deviation< T, S, M >::take ( const argument t)
template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
void mln::accu::stat::deviation< T, S, M >::take ( const deviation< T, S, M > &  other)
void mln::Accumulator< deviation< T, S, M > >::take_as_init ( const T t)
inherited

Take as initialization the value t.

void mln::Accumulator< deviation< T, S, M > >::take_as_init_ ( const T t)
inherited

INTERNAL_API

Default implementation of "take as initialization".

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

Take n times the value t.

void mln::Accumulator< deviation< T, S, M > >::take_n_times_ ( unsigned  n,
const T t 
)
inherited

INTERNAL_API

Default implementation of "take n times".

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
M mln::accu::stat::deviation< T, S, M >::to_result ( ) const

Get the value of the accumulator.

Member Data Documentation

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
accu::math::count<T> mln::accu::stat::deviation< T, S, M >::count_
protected

Definition at line 86 of file deviation.hh.

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
T mln::accu::stat::deviation< T, S, M >::mean_
protected

Definition at line 92 of file deviation.hh.

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
accu::math::sum<typename mln::value::props< T >::sum,S> mln::accu::stat::deviation< T, S, M >::sum_
protected

Definition at line 91 of file deviation.hh.

Member Typedef Documentation

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
typedef T mln::accu::stat::deviation< T, S, M >::argument

Definition at line 64 of file deviation.hh.

typedef Accumulator<void> mln::Accumulator< deviation< T, S, M > >::category
inherited

Definition at line 64 of file accumulator.hh.

typedef deviation< T, S, M > mln::Object< deviation< T, S, M > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef M mln::accu::internal::base< M , deviation< T, S, M > >::q_result
inherited

Definition at line 58 of file base.hh.

template<typename T, typename S = typename mln::value::props< T >::sum, typename M = S>
typedef M mln::accu::stat::deviation< T, S, M >::result

Definition at line 65 of file deviation.hh.