mln::accu::stat::max_h< V > Struct Template Reference
[On values]

Generic max function based on histogram over a value set with type V. More...

#include <max_h.hh>

Inheritance diagram for mln::accu::stat::max_h< V >:

List of all members.

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

---

Detailed Description

template<typename V>
struct mln::accu::stat::max_h< V >

Generic max function based on histogram over a value set with type V.

Definition at line 100 of file max_h.hh.

---

Member Typedef Documentation

template<typename V>

typedef V mln::accu::stat::max_h< V >::argument

Definition at line 102 of file max_h.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 V>

mln::accu::stat::max_h< V >::max_h

(

)

[inline]

Definition at line 167 of file max_h.hh.

References mln::accu::stat::max_h< V >::init(), and mln::accu::stat::max_h< V >::invariant_().

---

Member Function Documentation

template<typename V>

unsigned mln::accu::stat::max_h< V >::card

(

)

const [inline]

Definition at line 115 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_.

Referenced by mln::accu::stat::max_h< V >::take().

template<typename V>

void mln::accu::stat::max_h< V >::debug_print_

(

)

const [inline]

Definition at line 331 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::sum_, mln::accu::stat::max_h< V >::t_, and mln::accu::stat::max_h< V >::valid_.

template<typename V>

void mln::accu::stat::max_h< V >::go_minus_

(

)

const [inline, protected]

Definition at line 269 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::s_, and mln::accu::stat::max_h< V >::t_.

Referenced by mln::accu::stat::max_h< V >::update_().

template<typename V>

void mln::accu::stat::max_h< V >::go_plus_

(

)

const [inline, protected]

Definition at line 254 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::s_, mln::accu::stat::max_h< V >::sum_, and mln::accu::stat::max_h< V >::t_.

Referenced by mln::accu::stat::max_h< V >::update_().

template<typename V>

const accu::histo< V > & mln::accu::stat::max_h< V >::histo

(

)

const [inline]

Definition at line 315 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_.

template<typename V>

void mln::accu::stat::max_h< V >::init

(

)

[inline]

Manipulators.

Definition at line 280 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::s_, mln::accu::stat::max_h< V >::sum_, mln::accu::stat::max_h< V >::t_, and mln::accu::stat::max_h< V >::valid_.

Referenced by mln::accu::stat::max_h< V >::max_h(), and mln::accu::stat::max_h< V >::untake().

template<typename V>

void mln::accu::stat::max_h< V >::invariant_

(

)

const [inline, protected]

Definition at line 159 of file max_h.hh.

References mln::accu::stat::max_h< V >::sum_, and mln::accu::stat::max_h< V >::valid_.

Referenced by mln::accu::stat::max_h< V >::max_h(), mln::accu::stat::max_h< V >::take(), mln::accu::stat::max_h< V >::to_result(), and mln::accu::stat::max_h< V >::untake().

template<typename V>

bool mln::accu::stat::max_h< V >::is_valid

(

)

const [inline]

Check whether this accu is able to return a result.

Always true here.

Definition at line 323 of file max_h.hh.

template<typename R, typename E>

R base::subj_

(

)

[inline, inherited]

Definition at line 77 of file base.hh.

References mln::exact().

template<typename V>

void mln::accu::stat::max_h< V >::take

(

const max_h< V > &

other

)

[inline]

Definition at line 197 of file max_h.hh.

References mln::accu::stat::max_h< V >::card(), mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::invariant_(), mln::accu::stat::max_h< V >::sum_, and mln::accu::stat::max_h< V >::valid_.

template<typename V>

void mln::accu::stat::max_h< V >::take

(

const argument &

t

)

[inline]

Definition at line 178 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::invariant_(), mln::accu::stat::max_h< V >::sum_, mln::accu::stat::max_h< V >::t_, mln::accu::stat::max_h< V >::take_as_init_(), and mln::accu::stat::max_h< V >::valid_.

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

void mln::accu::stat::max_h< V >::take_as_init_

(

const argument &

t

)

[inline]

Definition at line 292 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::s_, mln::accu::stat::max_h< V >::sum_, mln::accu::stat::max_h< V >::t_, and mln::accu::stat::max_h< V >::valid_.

Referenced by mln::accu::stat::max_h< V >::take().

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

const max_h< V >::argument & mln::accu::stat::max_h< V >::to_result

(

)

const [inline]

Get the value of the accumulator.

Definition at line 304 of file max_h.hh.

References mln::accu::stat::max_h< V >::invariant_(), mln::accu::stat::max_h< V >::t_, mln::accu::stat::max_h< V >::update_(), and mln::accu::stat::max_h< V >::valid_.

template<typename V>

void mln::accu::stat::max_h< V >::untake

(

const argument &

t

)

[inline]

Definition at line 212 of file max_h.hh.

References mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::init(), mln::accu::stat::max_h< V >::invariant_(), mln::accu::stat::max_h< V >::sum_, mln::accu::stat::max_h< V >::t_, and mln::accu::stat::max_h< V >::valid_.

template<typename V>

void mln::accu::stat::max_h< V >::update_

(

)

const [inline, protected]

Definition at line 236 of file max_h.hh.

References mln::accu::stat::max_h< V >::go_minus_(), mln::accu::stat::max_h< V >::go_plus_(), mln::accu::stat::max_h< V >::h_, mln::accu::stat::max_h< V >::i_, mln::accu::stat::max_h< V >::sum_, and mln::accu::stat::max_h< V >::valid_.

Referenced by mln::accu::stat::max_h< V >::to_result().

---

Member Data Documentation

template<typename V>

accu::histo<V> mln::accu::stat::max_h< V >::h_ [mutable, protected]

Definition at line 130 of file max_h.hh.

Referenced by mln::accu::stat::max_h< V >::card(), mln::accu::stat::max_h< V >::debug_print_(), mln::accu::stat::max_h< V >::go_minus_(), mln::accu::stat::max_h< V >::go_plus_(), mln::accu::stat::max_h< V >::histo(), mln::accu::stat::max_h< V >::init(), mln::accu::stat::max_h< V >::take(), mln::accu::stat::max_h< V >::take_as_init_(), mln::accu::stat::max_h< V >::untake(), and mln::accu::stat::max_h< V >::update_().

template<typename V>

unsigned mln::accu::stat::max_h< V >::i_ [mutable, protected]

Definition at line 134 of file max_h.hh.

Referenced by mln::accu::stat::max_h< V >::debug_print_(), mln::accu::stat::max_h< V >::go_minus_(), mln::accu::stat::max_h< V >::go_plus_(), mln::accu::stat::max_h< V >::init(), mln::accu::stat::max_h< V >::take(), mln::accu::stat::max_h< V >::take_as_init_(), mln::accu::stat::max_h< V >::untake(), and mln::accu::stat::max_h< V >::update_().

template<typename V>

const value::set<V>& mln::accu::stat::max_h< V >::s_ [protected]

Definition at line 131 of file max_h.hh.

Referenced by mln::accu::stat::max_h< V >::go_minus_(), mln::accu::stat::max_h< V >::go_plus_(), mln::accu::stat::max_h< V >::init(), and mln::accu::stat::max_h< V >::take_as_init_().

template<typename V>

unsigned mln::accu::stat::max_h< V >::sum_ [mutable, protected]

Definition at line 133 of file max_h.hh.

Referenced by mln::accu::stat::max_h< V >::debug_print_(), mln::accu::stat::max_h< V >::go_plus_(), mln::accu::stat::max_h< V >::init(), mln::accu::stat::max_h< V >::invariant_(), mln::accu::stat::max_h< V >::take(), mln::accu::stat::max_h< V >::take_as_init_(), mln::accu::stat::max_h< V >::untake(), and mln::accu::stat::max_h< V >::update_().

template<typename V>

argument mln::accu::stat::max_h< V >::t_ [mutable, protected]

Definition at line 135 of file max_h.hh.

Referenced by mln::accu::stat::max_h< V >::debug_print_(), mln::accu::stat::max_h< V >::go_minus_(), mln::accu::stat::max_h< V >::go_plus_(), mln::accu::stat::max_h< V >::init(), mln::accu::stat::max_h< V >::take(), mln::accu::stat::max_h< V >::take_as_init_(), mln::accu::stat::max_h< V >::to_result(), and mln::accu::stat::max_h< V >::untake().

template<typename V>

bool mln::accu::stat::max_h< V >::valid_ [mutable, protected]

Definition at line 137 of file max_h.hh.

Referenced by mln::accu::stat::max_h< V >::debug_print_(), mln::accu::stat::max_h< V >::init(), mln::accu::stat::max_h< V >::invariant_(), mln::accu::stat::max_h< V >::take(), mln::accu::stat::max_h< V >::take_as_init_(), mln::accu::stat::max_h< V >::to_result(), mln::accu::stat::max_h< V >::untake(), and mln::accu::stat::max_h< V >::update_().