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

#include <mln/accu/rms.hh>

Public Member Functions

 rms ()
hook_value_ () const
bool is_valid () const
subj_ ()
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_as_init_ (const T &p)
void take (const T &p)
void take (const rms< T, V > &other)

Protected Attributes

unsigned count_
v_

Public Types

typedef T argument
typedef Accumulator< void > category
typedef rms< T, V > exact_t
typedef V q_result
typedef mln::metal::unqualif
< V >::ret 
result

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 rms.hh.

Constructor & Destructor Documentation

template<typename T, typename V>
mln::accu::rms< T, V >::rms ( )

Member Function Documentation

template<typename T, typename V>
V mln::accu::rms< T, V >::hook_value_ ( ) const

Return the underlying value used to compute the result.

v = sum(t * t);

template<typename T, typename V>
void mln::accu::rms< T, V >::init ( )

Manipulators.

template<typename T, typename V>
bool mln::accu::rms< T, V >::is_valid ( ) const

Check whether this accu is able to return a result.

Always true here.

V mln::accu::internal::base< V , rms< T, V > >::subj_ ( )
inherited
template<typename T, typename V>
void mln::accu::rms< T, V >::take ( const T p)
template<typename T, typename V>
void mln::accu::rms< T, V >::take ( const rms< T, V > &  other)
void mln::Accumulator< rms< T, V > >::take_as_init ( const T t)
inherited

Take as initialization the value t.

template<typename T, typename V>
void mln::accu::rms< T, V >::take_as_init_ ( const T t)

INTERNAL_API

Default implementation of "take as initialization".

Reimplemented from mln::Accumulator< rms< T, V > >.

void mln::Accumulator< rms< T, V > >::take_n_times ( unsigned  n,
const T t 
)
inherited

Take n times the value t.

void mln::Accumulator< rms< T, V > >::take_n_times_ ( unsigned  n,
const T t 
)
inherited

INTERNAL_API

Default implementation of "take n times".

template<typename T, typename V>
V mln::accu::rms< T, V >::to_result ( ) const

Get the value of the accumulator.

Member Data Documentation

template<typename T, typename V>
unsigned mln::accu::rms< T, V >::count_
protected

Definition at line 80 of file rms.hh.

template<typename T, typename V>
V mln::accu::rms< T, V >::v_
protected

Definition at line 79 of file rms.hh.

Member Typedef Documentation

template<typename T, typename V>
typedef T mln::accu::rms< T, V >::argument

Definition at line 54 of file rms.hh.

typedef Accumulator<void> mln::Accumulator< rms< T, V > >::category
inherited

Definition at line 64 of file accumulator.hh.

typedef rms< T, V > mln::Object< rms< T, V > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef V mln::accu::internal::base< V , rms< T, V > >::q_result
inherited

Definition at line 58 of file base.hh.

typedef mln::metal::unqualif< V >::ret mln::accu::internal::base< V , rms< T, V > >::result
inherited

Definition at line 59 of file base.hh.