mln::accu::math::sum< T, S > Struct Template Reference
[On values]
Generic sum accumulator class.
More...
#include <sum.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 | |
| bool | is_valid () const |
| Check whether this accu is able to return a result. | |
| R | subj_ () |
| sum () | |
| 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". | |
| const S & | to_result () const |
| Get the value of the accumulator. | |
| void | init () |
| Manipulators. | |
| void | set_value (const S &s) |
| void | take (const sum< T, S > &other) |
| void | take (const argument &t) |
| void | take_as_init_ (const argument &t) |
| Default implementation of "take as initialization". | |
| void | untake (const sum< T, S > &other) |
| void | untake (const argument &t) |
Protected Attributes | |
| S | s_ |
Detailed Description
template<typename T, typename S = typename mln::value::props< T >::sum>
struct mln::accu::math::sum< T, S >
Generic sum accumulator class.
Parameter T is the type of values that we sum. Parameter S is the type to store the value sum; the default type of S is the summation type (property) of T.
Definition at line 111 of file accu/math/sum.hh.
Member Typedef Documentation
| typedef T mln::accu::math::sum< T, S >::argument |
Definition at line 113 of file accu/math/sum.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::math::sum< T, S >::sum | ( | ) | [inline] |
Member Function Documentation
| void mln::accu::math::sum< T, S >::init | ( | ) | [inline] |
Manipulators.
Definition at line 160 of file accu/math/sum.hh.
References mln::accu::math::sum< T, S >::s_, and mln::literal::zero.
Referenced by mln::accu::math::sum< T, S >::sum().
| bool mln::accu::math::sum< T, S >::is_valid | ( | ) | const [inline] |
Check whether this accu is able to return a result.
Always true here.
Definition at line 221 of file accu/math/sum.hh.
| void mln::accu::math::sum< T, S >::set_value | ( | const S & | s | ) | [inline] |
| R base::subj_ | ( | ) | [inline, inherited] |
| void mln::accu::math::sum< T, S >::take | ( | const sum< T, S > & | other | ) | [inline] |
| void mln::accu::math::sum< T, S >::take | ( | const argument & | t | ) | [inline] |
Definition at line 167 of file accu/math/sum.hh.
References mln::accu::math::sum< T, S >::s_.
Referenced by mln::registration::compute_distance_criteria().
| 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::math::sum< T, S >::take_as_init_ | ( | const argument & | t | ) | [inline] |
Default implementation of "take as initialization".
Reimplemented from mln::Accumulator< E >.
Definition at line 181 of file accu/math/sum.hh.
References mln::accu::math::sum< T, S >::s_.
| 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().
| const S & mln::accu::math::sum< T, S >::to_result | ( | ) | const [inline] |
Get the value of the accumulator.
Definition at line 205 of file accu/math/sum.hh.
References mln::accu::math::sum< T, S >::s_.
| void mln::accu::math::sum< T, S >::untake | ( | const sum< T, S > & | other | ) | [inline] |
| void mln::accu::math::sum< T, S >::untake | ( | const argument & | t | ) | [inline] |
Member Data Documentation
S mln::accu::math::sum< T, S >::s_ [protected] |
Definition at line 138 of file accu/math/sum.hh.
Referenced by mln::accu::math::sum< T, S >::init(), mln::accu::math::sum< T, S >::set_value(), mln::accu::math::sum< T, S >::take(), mln::accu::math::sum< T, S >::take_as_init_(), mln::accu::math::sum< T, S >::to_result(), and mln::accu::math::sum< T, S >::untake().
