mln::accu::stat::rank< T > Struct Template Reference
[On values]

Generic rank accumulator class. More...

#include <rank.hh>

Inheritance diagram for mln::accu::stat::rank< T >:

List of all members.

Public Types
typedef T	argument
typedef Accumulator< void >	category
typedef E	exact_t
typedef R	q_result
typedef mln::metal::unqualif < R >::ret	result
typedef mln::value::set< T >	S
Public Member Functions
unsigned	card () const
bool	is_valid () const
	Check whether this accu is able to return a result.
unsigned	k () const
	Give the rank.
	rank (unsigned k)
	rank ()
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".
const T &	to_result () const
	Get the value of the accumulator.
void	init ()
	Manipulators.
void	take (const rank< T > &other)
void	take (const argument &t)
void	untake (const rank< T > &other)
void	untake (const argument &t)
Protected Member Functions
void	go_minus_ () const
void	go_plus_ () const
void	update_ () const
Protected Attributes
accu::histo< T >	h_
unsigned	i_
unsigned	k_
const S &	s_
unsigned	sum_minus_
unsigned	sum_plus_
argument	t_
bool	valid_

---

Detailed Description

template<typename T>
struct mln::accu::stat::rank< T >

Generic rank accumulator class.

The parameter T is the type of values.

Definition at line 60 of file rank.hh.

---

Member Typedef Documentation

template<typename T>

typedef T mln::accu::stat::rank< T >::argument

Definition at line 62 of file rank.hh.

template<typename E>

typedef Accumulator<void> mln::Accumulator< E >::category [inherited]

Reimplemented from mln::Proxy< E >.

Definition at line 80 of file accumulator.hh.

template<typename E>

typedef E mln::Object< E >::exact_t [inherited]

Definition at line 172 of file object.hh.

template<typename R, typename E>

typedef R mln::accu::internal::base< R, E >::q_result [inherited]

Definition at line 58 of file base.hh.

template<typename R, typename E>

typedef mln::metal::unqualif< R >::ret mln::accu::internal::base< R, E >::result [inherited]

Reimplemented in mln::accu::center< P, V >, mln::accu::max_site< I >, mln::accu::site_set::rectangularity< P >, mln::accu::stat::deviation< T, S, M >, mln::accu::stat::mean< T, S, M >, mln::accu::stat::var< T >, and mln::accu::stat::variance< T, S, R >.

Definition at line 59 of file base.hh.

template<typename T>

typedef mln::value::set<T> mln::accu::stat::rank< T >::S

Definition at line 63 of file rank.hh.

---

Constructor & Destructor Documentation

template<typename T>

mln::accu::stat::rank< T >::rank

(

)

[inline]

Definition at line 158 of file rank.hh.

References mln::accu::stat::rank< T >::init().

template<typename T>

mln::accu::stat::rank< T >::rank

(

unsigned

k

)

[inline, explicit]

Definition at line 167 of file rank.hh.

References mln::accu::stat::rank< T >::init().

---

Member Function Documentation

template<typename T>

unsigned mln::accu::stat::rank< T >::card

(

)

const [inline]

Definition at line 77 of file rank.hh.

References mln::accu::stat::rank< T >::h_, and mln::accu::histo< V >::sum().

template<typename T>

void mln::accu::stat::rank< T >::go_minus_

(

)

const [inline, protected]

Definition at line 285 of file rank.hh.

References mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::i_, mln::accu::stat::rank< T >::k_, mln::accu::stat::rank< T >::s_, mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, and mln::accu::stat::rank< T >::t_.

Referenced by mln::accu::stat::rank< T >::update_().

template<typename T>

void mln::accu::stat::rank< T >::go_plus_

(

)

const [inline, protected]

Definition at line 302 of file rank.hh.

References mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::i_, mln::accu::stat::rank< T >::k_, mln::accu::stat::rank< T >::s_, mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, and mln::accu::stat::rank< T >::t_.

Referenced by mln::accu::stat::rank< T >::update_().

template<typename T>

void mln::accu::stat::rank< T >::init

(

)

[inline]

Manipulators.

Definition at line 319 of file rank.hh.

References mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::i_, mln::accu::histo< V >::init(), mln::accu::stat::rank< T >::s_, mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, mln::accu::stat::rank< T >::t_, and mln::accu::stat::rank< T >::valid_.

Referenced by mln::accu::stat::rank< bool >::rank(), mln::accu::stat::rank< T >::rank(), and mln::morpho::impl::generic::rank_filter().

template<typename T>

bool mln::accu::stat::rank< T >::is_valid

(

)

const [inline]

Check whether this accu is able to return a result.

Always true here.

Definition at line 343 of file rank.hh.

References mln::accu::stat::rank< T >::valid_.

template<typename T>

unsigned mln::accu::stat::rank< T >::k

(

)

const [inline]

Give the rank.

Definition at line 178 of file rank.hh.

References mln::accu::stat::rank< T >::k_.

template<typename R, typename E>

R base::subj_

(

)

[inline, inherited]

Definition at line 77 of file base.hh.

References mln::exact().

template<typename T>

void mln::accu::stat::rank< T >::take

(

const rank< T > &

other

)

[inline]

Definition at line 201 of file rank.hh.

References mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::i_, mln::accu::histo< V >::nvalues(), mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, mln::accu::histo< V >::take(), and mln::accu::stat::rank< T >::valid_.

template<typename T>

void mln::accu::stat::rank< T >::take

(

const argument &

t

)

[inline]

Definition at line 185 of file rank.hh.

References mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, mln::accu::stat::rank< T >::t_, mln::accu::histo< V >::take(), and mln::accu::stat::rank< T >::valid_.

Referenced by mln::morpho::impl::generic::rank_filter().

template<typename E>

template<typename T>

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

template<typename E>

template<typename T>

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

template<typename E>

template<typename T>

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

template<typename E>

template<typename T>

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

template<typename T>

const T & mln::accu::stat::rank< T >::to_result

(

)

const [inline]

Get the value of the accumulator.

Definition at line 333 of file rank.hh.

References mln::accu::stat::rank< T >::t_, mln::accu::stat::rank< T >::update_(), and mln::accu::stat::rank< T >::valid_.

template<typename T>

void mln::accu::stat::rank< T >::untake

(

const rank< T > &

other

)

[inline]

Definition at line 239 of file rank.hh.

References mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::i_, mln::accu::histo< V >::nvalues(), mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, mln::accu::histo< V >::untake(), and mln::accu::stat::rank< T >::valid_.

template<typename T>

void mln::accu::stat::rank< T >::untake

(

const argument &

t

)

[inline]

Definition at line 222 of file rank.hh.

References mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, mln::accu::stat::rank< T >::t_, mln::accu::histo< V >::untake(), and mln::accu::stat::rank< T >::valid_.

template<typename T>

void mln::accu::stat::rank< T >::update_

(

)

const [inline, protected]

Definition at line 259 of file rank.hh.

References mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), mln::accu::stat::rank< T >::h_, mln::accu::stat::rank< T >::i_, mln::accu::stat::rank< T >::k_, mln::accu::histo< V >::sum(), mln::accu::stat::rank< T >::sum_minus_, mln::accu::stat::rank< T >::sum_plus_, and mln::accu::stat::rank< T >::valid_.

Referenced by mln::accu::stat::rank< T >::to_result().

---

Member Data Documentation

template<typename T>

accu::histo<T> mln::accu::stat::rank< T >::h_ [mutable, protected]

Definition at line 93 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::card(), mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), mln::accu::stat::rank< T >::init(), mln::accu::stat::rank< T >::take(), mln::accu::stat::rank< T >::untake(), and mln::accu::stat::rank< T >::update_().

template<typename T>

unsigned mln::accu::stat::rank< T >::i_ [mutable, protected]

Definition at line 99 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), mln::accu::stat::rank< T >::init(), mln::accu::stat::rank< T >::take(), mln::accu::stat::rank< T >::untake(), and mln::accu::stat::rank< T >::update_().

template<typename T>

unsigned mln::accu::stat::rank< T >::k_ [protected]

Definition at line 91 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), mln::accu::stat::rank< T >::k(), mln::accu::stat::rank< bool >::to_result(), and mln::accu::stat::rank< T >::update_().

template<typename T>

const S& mln::accu::stat::rank< T >::s_ [protected]

Definition at line 94 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), and mln::accu::stat::rank< T >::init().

template<typename T>

unsigned mln::accu::stat::rank< T >::sum_minus_ [mutable, protected]

Definition at line 96 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), mln::accu::stat::rank< T >::init(), mln::accu::stat::rank< T >::take(), mln::accu::stat::rank< T >::untake(), and mln::accu::stat::rank< T >::update_().

template<typename T>

unsigned mln::accu::stat::rank< T >::sum_plus_ [mutable, protected]

Definition at line 96 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), mln::accu::stat::rank< T >::init(), mln::accu::stat::rank< T >::take(), mln::accu::stat::rank< T >::untake(), and mln::accu::stat::rank< T >::update_().

template<typename T>

argument mln::accu::stat::rank< T >::t_ [mutable, protected]

Definition at line 100 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::go_minus_(), mln::accu::stat::rank< T >::go_plus_(), mln::accu::stat::rank< T >::init(), mln::accu::stat::rank< T >::take(), mln::accu::stat::rank< T >::to_result(), and mln::accu::stat::rank< T >::untake().

template<typename T>

bool mln::accu::stat::rank< T >::valid_ [mutable, protected]

Definition at line 98 of file rank.hh.

Referenced by mln::accu::stat::rank< T >::init(), mln::accu::stat::rank< T >::is_valid(), mln::accu::stat::rank< T >::take(), mln::accu::stat::rank< T >::to_result(), mln::accu::stat::rank< T >::untake(), and mln::accu::stat::rank< T >::update_().