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

Generic rank accumulator class. More...

#include <rank_high_quant.hh>

Inheritance diagram for mln::accu::stat::rank_high_quant< 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
Public Member Functions
bool	is_valid () const
	Check whether this accu is able to return a result.
	rank_high_quant (unsigned k, unsigned n)
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".
const T &	to_result () const
	Get the value of the accumulator.
void	init ()
	Manipulators.
void	sort ()
void	take (const rank_high_quant< T > &other)
void	take (const argument &t)
void	take_as_init_ (const argument &t)
	Default implementation of "take as initialization".
Protected Attributes
std::vector< T >	elts_
bool	is_sorted_
unsigned	k_
unsigned	n_

---

Detailed Description

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

Generic rank accumulator class.

The parameter T is the type of values.

Definition at line 57 of file rank_high_quant.hh.

---

Member Typedef Documentation

template<typename T>

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

Definition at line 59 of file rank_high_quant.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.

---

Constructor & Destructor Documentation

template<typename T>

mln::accu::stat::rank_high_quant< T >::rank_high_quant	(	unsigned	k,
		unsigned	n
	)			[inline]

Definition at line 136 of file rank_high_quant.hh.

References mln::accu::stat::rank_high_quant< T >::init(), mln::accu::stat::rank_high_quant< T >::k_, and mln::accu::stat::rank_high_quant< T >::n_.

---

Member Function Documentation

template<typename T>

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

(

)

[inline]

Manipulators.

Definition at line 148 of file rank_high_quant.hh.

References mln::accu::stat::rank_high_quant< T >::elts_.

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

template<typename T>

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

(

)

const [inline]

Check whether this accu is able to return a result.

Always true here.

Definition at line 197 of file rank_high_quant.hh.

template<typename T>

void mln::accu::stat::rank_high_quant< T >::sort

(

)

[inline]

Definition at line 205 of file rank_high_quant.hh.

References mln::accu::stat::rank_high_quant< T >::elts_, and mln::accu::stat::rank_high_quant< T >::is_sorted_.

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_high_quant< T >::take

(

const rank_high_quant< T > &

other

)

[inline]

Definition at line 172 of file rank_high_quant.hh.

References mln::accu::stat::rank_high_quant< T >::elts_, and mln::accu::stat::rank_high_quant< T >::is_sorted_.

template<typename T>

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

(

const argument &

t

)

[inline]

Definition at line 163 of file rank_high_quant.hh.

References mln::accu::stat::rank_high_quant< T >::elts_, and mln::accu::stat::rank_high_quant< T >::is_sorted_.

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 T>

void mln::accu::stat::rank_high_quant< T >::take_as_init_

(

const argument &

t

)

[inline]

Default implementation of "take as initialization".

Reimplemented from mln::Accumulator< E >.

Definition at line 155 of file rank_high_quant.hh.

References mln::accu::stat::rank_high_quant< T >::elts_, and mln::accu::stat::rank_high_quant< T >::is_sorted_.

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_high_quant< T >::to_result

(

)

const [inline]

Get the value of the accumulator.

Definition at line 183 of file rank_high_quant.hh.

References mln::accu::stat::rank_high_quant< T >::elts_, mln::accu::stat::rank_high_quant< T >::k_, and mln::accu::stat::rank_high_quant< T >::n_.

---

Member Data Documentation

template<typename T>

std::vector<T> mln::accu::stat::rank_high_quant< T >::elts_ [protected]

Definition at line 81 of file rank_high_quant.hh.

Referenced by mln::accu::stat::rank_high_quant< T >::init(), mln::accu::stat::rank_high_quant< T >::sort(), mln::accu::stat::rank_high_quant< T >::take(), mln::accu::stat::rank_high_quant< T >::take_as_init_(), and mln::accu::stat::rank_high_quant< T >::to_result().

template<typename T>

bool mln::accu::stat::rank_high_quant< T >::is_sorted_ [protected]

Definition at line 82 of file rank_high_quant.hh.

Referenced by mln::accu::stat::rank_high_quant< T >::sort(), mln::accu::stat::rank_high_quant< T >::take(), and mln::accu::stat::rank_high_quant< T >::take_as_init_().

template<typename T>

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

Definition at line 83 of file rank_high_quant.hh.

Referenced by mln::accu::stat::rank_high_quant< T >::rank_high_quant(), and mln::accu::stat::rank_high_quant< T >::to_result().

template<typename T>

unsigned mln::accu::stat::rank_high_quant< T >::n_ [protected]

Definition at line 84 of file rank_high_quant.hh.

Referenced by mln::accu::stat::rank_high_quant< T >::rank_high_quant(), and mln::accu::stat::rank_high_quant< T >::to_result().