mln::accu::rms< T, V > Struct Template Reference [On values]

Generic root mean square accumulator class. More...

#include <rms.hh>

Inheritance diagram for mln::accu::rms< T, V >:

List of all members.

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
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 ()
V	subj_ ()
void	take_as_init (const T &t)
	Take as initialization the value t.
void	take_as_init_ (const T &t)
	Default implementation of "take as initialization".
void	take_n_times (unsigned n, const T &t)
	Take n times the value 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_as_init_ (const T &p)
void	take (const T &p)
void	take (const rms< T, V > &other)
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.

---

Member Typedef Documentation

template<typename T, typename V>

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

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

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

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

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

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

---

Constructor & Destructor Documentation

template<typename T , typename V >

mln::accu::rms< T, V >::rms

(

)

[inline]

References mln::accu::rms< T, V >::init().

---

Member Function Documentation

template<typename T , typename V >

V mln::accu::rms< T, V >::hook_value_

(

)

const [inline]

Return the underlying value used to compute the result.

v = sum(t * t);

References mln::accu::rms< T, V >::v_.

Referenced by mln::registration::compute_standard_deviation().

template<typename T , typename V >

void mln::accu::rms< T, V >::init

(

)

[inline]

Manipulators.

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().

template<typename T , typename V >

bool mln::accu::rms< T, V >::is_valid

(

)

const [inline]

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 rms< T, V > &

other

)

[inline]

References mln::accu::rms< T, V >::count_, and mln::accu::rms< T, V >::v_.

template<typename T , typename V >

void mln::accu::rms< T, V >::take

(

const T &

p

)

[inline]

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< rms< T, V > >::take_as_init

(

const T &

t

)

[inherited]

Take as initialization the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

template<typename T , typename V >

void mln::accu::rms< T, V >::take_as_init_

(

const T &

p

)

[inline]

References mln::accu::rms< T, V >::count_, and mln::accu::rms< T, V >::v_.

void mln::Accumulator< rms< T, V > >::take_as_init_

(

const T &

t

)

[inherited]

Default implementation of "take as initialization".

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

Take n times the value t.

Dev note: this is a final method; override if needed by take_as_init_ (ending with '_').

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

Default implementation of "take n times".

template<typename T , typename V >

V mln::accu::rms< T, V >::to_result

(

)

const [inline]

Get the value of the accumulator.

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

template<typename T, typename V>

unsigned mln::accu::rms< T, V >::count_ [protected]

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().

template<typename T, typename V>

V mln::accu::rms< T, V >::v_ [protected]

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().