mln::accu::stat::deviation< T, S, M > Struct Template Reference
[On values]
Generic standard deviation accumulator class.
More...
#include <deviation.hh>
Public Types | |
| typedef T | argument |
| typedef Accumulator< void > | category |
| typedef E | exact_t |
| typedef R | q_result |
| typedef M | result |
Public Member Functions | |
| deviation (const T mean) | |
| bool | is_valid () const |
| Check whether this accu is able to return a result. | |
| operator M () const | |
| R | subj_ () |
| template<typename T> | |
| void | take_as_init (const T &t) |
Take as initialization the value t. | |
| template<typename T> | |
| void | take_as_init_ (const T &t) |
| Default implementation of "take as initialization". | |
| template<typename T> | |
| void | take_n_times (unsigned n, const T &t) |
Take n times the value t. | |
| template<typename T> | |
| void | take_n_times_ (unsigned n, const T &t) |
| Default implementation of "take n times". | |
| M | to_result () const |
| Get the value of the accumulator. | |
| void | init () |
| Manipulators. | |
| void | take (const deviation< T, S, M > &other) |
| void | take (const argument &t) |
Protected Attributes | |
| accu::math::count< T > | count_ |
| T | mean_ |
| accu::math::sum< T, S > | sum_ |
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.
Member Typedef Documentation
| typedef T mln::accu::stat::deviation< T, S, M >::argument |
Definition at line 64 of file deviation.hh.
typedef Accumulator<void> mln::Accumulator< E >::category [inherited] |
typedef E mln::Object< E >::exact_t [inherited] |
typedef R mln::accu::internal::base< R, E >::q_result [inherited] |
| typedef M mln::accu::stat::deviation< T, S, M >::result |
Constructor & Destructor Documentation
| mln::accu::stat::deviation< T, S, M >::deviation | ( | const T | mean | ) | [inline] |
Definition at line 119 of file deviation.hh.
References mln::accu::stat::deviation< T, S, M >::init(), and mln::accu::stat::deviation< T, S, M >::mean_.
Member Function Documentation
| void mln::accu::stat::deviation< T, S, M >::init | ( | ) | [inline] |
Manipulators.
Definition at line 128 of file deviation.hh.
References mln::accu::stat::deviation< T, S, M >::count_, and mln::accu::stat::deviation< T, S, M >::sum_.
Referenced by mln::accu::stat::deviation< T, S, M >::deviation().
| bool mln::accu::stat::deviation< T, S, M >::is_valid | ( | ) | const [inline] |
Check whether this accu is able to return a result.
Always true here.
Definition at line 173 of file deviation.hh.
References mln::accu::stat::deviation< T, S, M >::count_.
| mln::accu::stat::deviation< T, S, M >::operator M | ( | ) | const [inline] |
Definition at line 165 of file deviation.hh.
References mln::accu::stat::deviation< T, S, M >::to_result().
| R base::subj_ | ( | ) | [inline, inherited] |
| void mln::accu::stat::deviation< T, S, M >::take | ( | const deviation< T, S, M > & | other | ) | [inline] |
Definition at line 145 of file deviation.hh.
References mln::accu::stat::deviation< T, S, M >::count_, and mln::accu::stat::deviation< T, S, M >::sum_.
| void mln::accu::stat::deviation< T, S, M >::take | ( | const argument & | t | ) | [inline] |
Definition at line 136 of file deviation.hh.
References mln::accu::stat::deviation< T, S, M >::count_, mln::accu::stat::deviation< T, S, M >::mean_, mln::math::sqr(), and mln::accu::stat::deviation< T, S, M >::sum_.
| 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 >.
Definition at line 186 of file accumulator.hh.
References mln::exact(), and mln::mln_exact().
Referenced by mln::morpho::elementary::impl::gradient_on_function(), and mln::morpho::elementary::impl::gradient_on_function_fastest().
| void mln::Accumulator< E >::take_as_init_ | ( | const T & | t | ) | [inline, inherited] |
Default implementation of "take as initialization".
Reimplemented in mln::accu::math::inf< T >, mln::accu::math::sum< T, S >, mln::accu::math::sup< T >, mln::accu::pair< A1, A2, T >, mln::accu::rms< T, V >, mln::accu::stat::max< T >, mln::accu::stat::min< T >, mln::accu::stat::rank_high_quant< T >, and mln::accu::stat::var< T >.
Definition at line 200 of file accumulator.hh.
References mln::exact().
| 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 '_').
Definition at line 213 of file accumulator.hh.
References mln::exact(), and mln::mln_exact().
| void mln::Accumulator< E >::take_n_times_ | ( | unsigned | n, | |
| const T & | t | |||
| ) | [inline, inherited] |
Default implementation of "take n times".
Reimplemented in mln::accu::stat::var< T >.
Definition at line 230 of file accumulator.hh.
References mln::exact().
| M mln::accu::stat::deviation< T, S, M >::to_result | ( | ) | const [inline] |
Get the value of the accumulator.
Definition at line 155 of file deviation.hh.
References mln::accu::stat::deviation< T, S, M >::count_, mln::math::sqrt(), and mln::accu::stat::deviation< T, S, M >::sum_.
Referenced by mln::accu::stat::deviation< T, S, M >::operator M().
Member Data Documentation
accu::math::count<T> mln::accu::stat::deviation< T, S, M >::count_ [protected] |
Definition at line 86 of file deviation.hh.
Referenced by mln::accu::stat::deviation< T, S, M >::init(), mln::accu::stat::deviation< T, S, M >::is_valid(), mln::accu::stat::deviation< T, S, M >::take(), and mln::accu::stat::deviation< T, S, M >::to_result().
T mln::accu::stat::deviation< T, S, M >::mean_ [protected] |
Definition at line 88 of file deviation.hh.
Referenced by mln::accu::stat::deviation< T, S, M >::deviation(), and mln::accu::stat::deviation< T, S, M >::take().
accu::math::sum<T,S> mln::accu::stat::deviation< T, S, M >::sum_ [protected] |
Definition at line 87 of file deviation.hh.
Referenced by mln::accu::stat::deviation< T, S, M >::init(), mln::accu::stat::deviation< T, S, M >::take(), and mln::accu::stat::deviation< T, S, M >::to_result().
