mln::accu::rms< T, V > Struct Template Reference
[On values]
Generic root mean square accumulator class.
More...
#include <rms.hh>
Public Types | |
| typedef T | argument |
| typedef Accumulator< void > | category |
| typedef E | exact_t |
| typedef R | q_result |
| typedef mln::metal::unqualif < R >::ret | result |
Public Member Functions | |
| V | hook_value_ () const |
| Return the underlying value used to compute the result. | |
| bool | is_valid () const |
| Check whether this accu is able to return a result. | |
| rms () | |
| R | subj_ () |
| 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. | |
| template<typename T> | |
| void | take_n_times_ (unsigned n, const T &t) |
| Default implementation of "take n times". | |
| V | to_result () const |
| Get the value of the accumulator. | |
| void | init () |
| Manipulators. | |
| void | take (const rms< T, V > &other) |
| void | take (const T &p) |
| void | take_as_init_ (const T &p) |
| Default implementation of "take as initialization". | |
Protected Attributes | |
| unsigned | count_ |
| V | v_ |
Detailed Description
template<typename T, typename V>
struct mln::accu::rms< T, V >
Generic root mean square accumulator class.
The parameter T is the type of the root mean square value.
Definition at line 52 of file accu/rms.hh.
Member Typedef Documentation
| typedef T mln::accu::rms< T, V >::argument |
Definition at line 54 of file accu/rms.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 mln::metal::unqualif< R >::ret mln::accu::internal::base< R, E >::result [inherited] |
Constructor & Destructor Documentation
| mln::accu::rms< T, V >::rms | ( | ) | [inline] |
Member Function Documentation
| V mln::accu::rms< T, V >::hook_value_ | ( | ) | const [inline] |
Return the underlying value used to compute the result.
v = sum(t * t);
Definition at line 158 of file accu/rms.hh.
References mln::accu::rms< T, V >::v_.
Referenced by mln::registration::compute_standard_deviation().
| void mln::accu::rms< T, V >::init | ( | ) | [inline] |
Manipulators.
Definition at line 112 of file accu/rms.hh.
References mln::accu::rms< T, V >::count_, mln::accu::rms< T, V >::v_, and mln::literal::zero.
Referenced by mln::accu::rms< T, V >::rms().
| bool mln::accu::rms< T, V >::is_valid | ( | ) | const [inline] |
Check whether this accu is able to return a result.
Always true here.
Definition at line 166 of file accu/rms.hh.
| R base::subj_ | ( | ) | [inline, inherited] |
| void mln::accu::rms< T, V >::take | ( | const rms< T, V > & | other | ) | [inline] |
Definition at line 139 of file accu/rms.hh.
References mln::accu::rms< T, V >::count_, and mln::accu::rms< T, V >::v_.
| void mln::accu::rms< T, V >::take | ( | const T & | p | ) | [inline] |
Definition at line 130 of file accu/rms.hh.
References mln::accu::rms< T, V >::count_, and mln::accu::rms< T, V >::v_.
Referenced by mln::registration::compute_d_k(), mln::registration::compute_standard_deviation(), and mln::registration::get_mu_yk().
| 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::accu::rms< T, V >::take_as_init_ | ( | const T & | t | ) | [inline] |
Default implementation of "take as initialization".
Reimplemented from mln::Accumulator< E >.
Definition at line 121 of file accu/rms.hh.
References mln::accu::rms< T, V >::count_, and mln::accu::rms< T, V >::v_.
| 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().
| V mln::accu::rms< T, V >::to_result | ( | ) | const [inline] |
Get the value of the accumulator.
Definition at line 148 of file accu/rms.hh.
References mln::accu::rms< T, V >::count_, and mln::accu::rms< T, V >::v_.
Referenced by mln::registration::compute_d_k(), mln::registration::compute_standard_deviation(), and mln::registration::get_mu_yk().
Member Data Documentation
unsigned mln::accu::rms< T, V >::count_ [protected] |
Definition at line 80 of file accu/rms.hh.
Referenced by mln::accu::rms< T, V >::init(), mln::accu::rms< T, V >::take(), mln::accu::rms< T, V >::take_as_init_(), and mln::accu::rms< T, V >::to_result().
V mln::accu::rms< T, V >::v_ [protected] |
Definition at line 79 of file accu/rms.hh.
Referenced by mln::accu::rms< T, V >::hook_value_(), mln::accu::rms< T, V >::init(), mln::accu::rms< T, V >::take(), mln::accu::rms< T, V >::take_as_init_(), and mln::accu::rms< T, V >::to_result().
