mln::accu::max_site< I > Struct Template Reference
[On images]

Define an accumulator that computes the first site with the maximum value in an image. More...

#include <max_site.hh>

Inheritance diagram for mln::accu::max_site< I >:

List of all members.

Public Types
typedef mln::util::pix< I >	argument
typedef Accumulator< void >	category
typedef E	exact_t
typedef R	q_result
typedef I::psite	result
Public Member Functions
bool	is_valid () const
	Check whether this accu is able to return a result.
	max_site ()
	operator typename I::psite () const
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".
I::psite	to_result () const
	Get the value of the accumulator.
I::value	value_ () const
	Underlying value.
void	init ()
	Manipulators.
void	take (const max_site< I > &other)
void	take (const argument &t)
Protected Attributes
bool	is_valid_
I::psite	max_p_
I::value	max_v_

---

Detailed Description

template<typename I>
struct mln::accu::max_site< I >

Define an accumulator that computes the first site with the maximum value in an image.

Definition at line 53 of file max_site.hh.

---

Member Typedef Documentation

template<typename I>

typedef mln::util::pix<I> mln::accu::max_site< I >::argument

Definition at line 55 of file max_site.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 I>

typedef I ::psite mln::accu::max_site< I >::result

Reimplemented from mln::accu::internal::base< R, E >.

Definition at line 56 of file max_site.hh.

---

Constructor & Destructor Documentation

template<typename I>

mln::accu::max_site< I >::max_site

(

)

[inline]

Definition at line 106 of file max_site.hh.

References mln::accu::max_site< I >::init().

---

Member Function Documentation

template<typename I>

void mln::accu::max_site< I >::init

(

)

[inline]

Manipulators.

Definition at line 114 of file max_site.hh.

References mln::accu::max_site< I >::is_valid_, and mln::accu::max_site< I >::max_v_.

Referenced by mln::accu::max_site< I >::max_site().

template<typename I>

bool mln::accu::max_site< I >::is_valid

(

)

const [inline]

Check whether this accu is able to return a result.

Always true here.

Definition at line 174 of file max_site.hh.

References mln::accu::max_site< I >::is_valid_.

Referenced by mln::accu::max_site< I >::take(), and mln::accu::max_site< I >::to_result().

template<typename I>

mln::accu::max_site< I >::operator typename I::psite

(

)

const [inline]

Definition at line 158 of file max_site.hh.

References mln::accu::max_site< I >::to_result().

template<typename R, typename E>

R base::subj_

(

)

[inline, inherited]

Definition at line 77 of file base.hh.

References mln::exact().

template<typename I>

void mln::accu::max_site< I >::take

(

const max_site< I > &

other

)

[inline]

Definition at line 135 of file max_site.hh.

References mln::accu::max_site< I >::is_valid(), mln::accu::max_site< I >::is_valid_, mln::accu::max_site< I >::max_p_, mln::accu::max_site< I >::max_v_, mln::accu::max_site< I >::to_result(), and mln::accu::max_site< I >::value_().

template<typename I>

void mln::accu::max_site< I >::take

(

const argument &

t

)

[inline]

Definition at line 122 of file max_site.hh.

References mln::accu::max_site< I >::is_valid_, mln::accu::max_site< I >::max_p_, mln::accu::max_site< I >::max_v_, mln::util::pix< I >::p(), and mln::util::pix< I >::v().

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

I::psite mln::accu::max_site< I >::to_result

(

)

const [inline]

Get the value of the accumulator.

Definition at line 150 of file max_site.hh.

References mln::accu::max_site< I >::is_valid(), and mln::accu::max_site< I >::max_p_.

Referenced by mln::accu::max_site< I >::operator typename I::psite(), and mln::accu::max_site< I >::take().

template<typename I>

I::value mln::accu::max_site< I >::value_

(

)

const [inline]

Underlying value.

Definition at line 166 of file max_site.hh.

References mln::accu::max_site< I >::max_v_.

Referenced by mln::accu::max_site< I >::take().

---

Member Data Documentation

template<typename I>

bool mln::accu::max_site< I >::is_valid_ [protected]

Definition at line 79 of file max_site.hh.

Referenced by mln::accu::max_site< I >::init(), mln::accu::max_site< I >::is_valid(), and mln::accu::max_site< I >::take().

template<typename I>

I ::psite mln::accu::max_site< I >::max_p_ [protected]

Definition at line 80 of file max_site.hh.

Referenced by mln::accu::max_site< I >::take(), and mln::accu::max_site< I >::to_result().

template<typename I>

I ::value mln::accu::max_site< I >::max_v_ [protected]

Definition at line 81 of file max_site.hh.

Referenced by mln::accu::max_site< I >::init(), mln::accu::max_site< I >::take(), and mln::accu::max_site< I >::value_().