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

Generic histogram class over a value set with type V. More...

#include <histo.hh>

Inheritance diagram for mln::accu::histo< V >:

List of all members.

Public Types
typedef V	argument
typedef Accumulator< void >	category
typedef histo< V >	exact_t
typedef const std::vector < unsigned > &	q_result
typedef mln::metal::unqualif < const std::vector< unsigned > & >::ret	result
Public Member Functions
	histo ()
bool	is_valid () const
	Check whether this accu is able to return a result.
const std::vector< unsigned > &	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".
const value::set< V > &	vset () const
void	take (const argument &t)
	Manipulators.
void	take (const histo< V > &other)
void	untake (const argument &t)
void	init ()
unsigned	operator() (const argument &t) const
unsigned	operator[] (unsigned i) const
unsigned	nvalues () const
unsigned	sum () const
const std::vector< unsigned > &	vect () const
	Get the value of the accumulator.
const std::vector< unsigned > &	to_result () const
Protected Attributes
mln::histo::array< V >	h_
unsigned	sum_

---

Detailed Description

template<typename V>
struct mln::accu::histo< V >

Generic histogram class over a value set with type V.

---

Member Typedef Documentation

template<typename V>

typedef V mln::accu::histo< V >::argument

typedef Accumulator<void> mln::Accumulator< histo< V > >::category [inherited]

Reimplemented from mln::Proxy< histo< V > >.

typedef histo< V > mln::Object< histo< V > >::exact_t [inherited]

typedef const std::vector< unsigned > & mln::accu::internal::base< const std::vector< unsigned > & , histo< V > >::q_result [inherited]

typedef mln::metal::unqualif< const std::vector< unsigned > & >::ret mln::accu::internal::base< const std::vector< unsigned > & , histo< V > >::result [inherited]

---

Constructor & Destructor Documentation

template<typename V >

mln::accu::histo< V >::histo

(

)

[inline]

---

Member Function Documentation

template<typename V >

void mln::accu::histo< V >::init

(

)

[inline]

References mln::histo::array< T >::clear(), mln::accu::histo< V >::h_, and mln::accu::histo< V >::sum_.

Referenced by mln::accu::stat::rank< T >::init(), mln::accu::stat::median_alt< S >::init(), and mln::accu::maj_h< T >::init().

template<typename V >

bool mln::accu::histo< V >::is_valid

(

)

const [inline]

Check whether this accu is able to return a result.

Always true here.

template<typename V >

unsigned mln::accu::histo< V >::nvalues

(

)

const [inline]

References mln::accu::histo< V >::h_, and mln::histo::array< T >::vset().

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

template<typename V >

unsigned mln::accu::histo< V >::operator()

(

const argument &

t

)

const [inline]

References mln::accu::histo< V >::h_, and mln::histo::array< T >::vset().

template<typename V >

unsigned mln::accu::histo< V >::operator[]

(

unsigned

i

)

const [inline]

References mln::accu::histo< V >::h_, and mln::histo::array< T >::vset().

const std::vector< unsigned > & mln::accu::internal::base< const std::vector< unsigned > & , histo< V > >::subj_

(

)

[inherited]

template<typename V >

unsigned mln::accu::histo< V >::sum

(

)

const [inline]

References mln::accu::histo< V >::sum_.

Referenced by mln::accu::stat::rank< T >::card(), mln::accu::stat::median_alt< value::set< T > >::debug__(), mln::accu::stat::median_alt< S >::go_minus_(), mln::accu::stat::median_alt< S >::go_plus_(), mln::accu::stat::median_alt< S >::take(), mln::accu::stat::median_alt< S >::untake(), and mln::accu::stat::rank< T >::update_().

template<typename V>

void mln::accu::histo< V >::take

(

const histo< V > &

other

)

[inline]

References mln::accu::histo< V >::h_, mln::histo::array< T >::nvalues(), and mln::accu::histo< V >::sum_.

template<typename V >

void mln::accu::histo< V >::take

(

const argument &

t

)

[inline]

Manipulators.

References mln::accu::histo< V >::h_, mln::accu::histo< V >::sum_, and mln::histo::array< T >::vset().

Referenced by mln::registration::compute_distance_criteria(), mln::accu::stat::rank< T >::take(), mln::accu::stat::median_alt< S >::take(), and mln::accu::maj_h< T >::take().

void mln::Accumulator< histo< 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 '_').

void mln::Accumulator< histo< V > >::take_as_init_

(

const T &

t

)

[inherited]

Default implementation of "take as initialization".

void mln::Accumulator< histo< 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< histo< V > >::take_n_times_	(	unsigned	n,
		const T &	t
	)			[inherited]

Default implementation of "take n times".

template<typename V >

const std::vector< unsigned > & mln::accu::histo< V >::to_result

(

)

const [inline]

References mln::accu::histo< V >::vect().

template<typename V >

void mln::accu::histo< V >::untake

(

const argument &

t

)

[inline]

References mln::accu::histo< V >::h_, mln::accu::histo< V >::sum_, and mln::histo::array< T >::vset().

Referenced by mln::accu::stat::rank< T >::untake(), mln::accu::stat::median_alt< S >::untake(), and mln::accu::maj_h< T >::untake().

template<typename V >

const std::vector< unsigned > & mln::accu::histo< V >::vect

(

)

const [inline]

Get the value of the accumulator.

References mln::accu::histo< V >::h_, and mln::histo::array< T >::vect().

Referenced by mln::accu::histo< V >::to_result(), and mln::accu::maj_h< T >::update_().

template<typename V >

const value::set< V > & mln::accu::histo< V >::vset

(

)

const [inline]

References mln::accu::histo< V >::h_, and mln::histo::array< T >::vset().

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

---

Member Data Documentation

template<typename V>

mln::histo::array<V> mln::accu::histo< V >::h_ [protected]

Referenced by mln::accu::histo< V >::init(), mln::accu::histo< V >::nvalues(), mln::accu::histo< V >::operator()(), mln::accu::histo< V >::operator[](), mln::accu::histo< V >::take(), mln::accu::histo< V >::untake(), mln::accu::histo< V >::vect(), and mln::accu::histo< V >::vset().

template<typename V>

unsigned mln::accu::histo< V >::sum_ [protected]

Referenced by mln::accu::histo< V >::init(), mln::accu::histo< V >::sum(), mln::accu::histo< V >::take(), and mln::accu::histo< V >::untake().