Public Types | Public Member Functions | Protected Attributes

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 >:
Inheritance graph

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.

Definition at line 56 of file accu/histo.hh.


Member Typedef Documentation

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

Definition at line 62 of file accu/histo.hh.

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

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

Definition at line 80 of file accumulator.hh.

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

Definition at line 173 of file object.hh.

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

Definition at line 58 of file base.hh.

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

Definition at line 59 of file base.hh.


Constructor & Destructor Documentation

template<typename V >
mln::accu::histo< V >::histo (  )  [inline]

Definition at line 120 of file accu/histo.hh.


Member Function Documentation

template<typename V >
void mln::accu::histo< V >::init (  )  [inline]
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.

Definition at line 236 of file accu/histo.hh.

template<typename V >
unsigned mln::accu::histo< V >::nvalues (  )  const [inline]
template<typename V >
unsigned mln::accu::histo< V >::operator() ( const argument t  )  const [inline]

Definition at line 168 of file accu/histo.hh.

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]

Definition at line 176 of file accu/histo.hh.

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]
template<typename V>
void mln::accu::histo< V >::take ( const histo< V > &  other  )  [inline]
template<typename V >
void mln::accu::histo< V >::take ( const argument t  )  [inline]
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]

Definition at line 209 of file accu/histo.hh.

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

template<typename V >
void mln::accu::histo< V >::untake ( const argument t  )  [inline]
template<typename V >
const std::vector< unsigned > & mln::accu::histo< V >::vect (  )  const [inline]

Get the value of the accumulator.

Definition at line 201 of file accu/histo.hh.

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]

Member Data Documentation

template<typename V>
mln::histo::array<V> mln::accu::histo< V >::h_ [protected]
template<typename V>
unsigned mln::accu::histo< V >::sum_ [protected]