$extrastylesheet
Olena  User documentation 2.1
An Image Processing Platform
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mln::accu::stat::rank< T > Struct Template Reference

#include <mln/accu/stat/rank.hh>

Public Member Functions

 rank ()
 rank (unsigned k)
unsigned card () const
bool is_valid () const
unsigned k () const
const Tsubj_ ()
void take_as_init (const T &t)
void take_as_init_ (const T &t)
void take_n_times (unsigned n, const T &t)
void take_n_times_ (unsigned n, const T &t)
const Tto_result () const
void init ()
void take (const argument &t)
void take (const rank< T > &other)
void untake (const argument &t)
void untake (const rank< T > &other)

Protected Member Functions

void go_minus_ () const
void go_plus_ () const
void update_ () const

Protected Attributes

accu::histo< Th_
unsigned i_
unsigned k_
const Ss_
unsigned sum_minus_
unsigned sum_plus_
argument t_
bool valid_

Public Types

typedef T argument
typedef Accumulator< void > category
typedef rank< Texact_t
typedef const Tq_result
typedef mln::metal::unqualif
< const T & >::ret 
result
typedef mln::value::set< TS

Detailed Description

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

Generic rank accumulator class.

The parameter T is the type of values.

Definition at line 60 of file rank.hh.

Constructor & Destructor Documentation

template<typename T>
mln::accu::stat::rank< T >::rank ( )
template<typename T>
mln::accu::stat::rank< T >::rank ( unsigned  k)
explicit

Member Function Documentation

template<typename T>
unsigned mln::accu::stat::rank< T >::card ( ) const
inline

Definition at line 77 of file rank.hh.

template<typename T>
void mln::accu::stat::rank< T >::go_minus_ ( ) const
protected
template<typename T>
void mln::accu::stat::rank< T >::go_plus_ ( ) const
protected
template<typename T>
void mln::accu::stat::rank< T >::init ( )

Manipulators.

template<typename T>
bool mln::accu::stat::rank< T >::is_valid ( ) const

Check whether this accu is able to return a result.

Always true here.

template<typename T>
unsigned mln::accu::stat::rank< T >::k ( ) const

Give the rank.

const T & mln::accu::internal::base< const T & , rank< T > >::subj_ ( )
inherited
template<typename T>
void mln::accu::stat::rank< T >::take ( const argument t)
template<typename T>
void mln::accu::stat::rank< T >::take ( const rank< T > &  other)
void mln::Accumulator< rank< T > >::take_as_init ( const T t)
inherited

Take as initialization the value t.

void mln::Accumulator< rank< T > >::take_as_init_ ( const T t)
inherited

INTERNAL_API

Default implementation of "take as initialization".

void mln::Accumulator< rank< T > >::take_n_times ( unsigned  n,
const T t 
)
inherited

Take n times the value t.

void mln::Accumulator< rank< T > >::take_n_times_ ( unsigned  n,
const T t 
)
inherited

INTERNAL_API

Default implementation of "take n times".

template<typename T>
const T& mln::accu::stat::rank< T >::to_result ( ) const

Get the value of the accumulator.

template<typename T>
void mln::accu::stat::rank< T >::untake ( const argument t)
template<typename T>
void mln::accu::stat::rank< T >::untake ( const rank< T > &  other)
template<typename T>
void mln::accu::stat::rank< T >::update_ ( ) const
protected

Member Data Documentation

template<typename T>
accu::histo<T> mln::accu::stat::rank< T >::h_
mutableprotected

Definition at line 93 of file rank.hh.

template<typename T>
unsigned mln::accu::stat::rank< T >::i_
mutableprotected

Definition at line 99 of file rank.hh.

template<typename T>
unsigned mln::accu::stat::rank< T >::k_
protected

Definition at line 91 of file rank.hh.

template<typename T>
const S& mln::accu::stat::rank< T >::s_
protected

Definition at line 94 of file rank.hh.

template<typename T>
unsigned mln::accu::stat::rank< T >::sum_minus_
mutableprotected

Definition at line 96 of file rank.hh.

template<typename T>
unsigned mln::accu::stat::rank< T >::sum_plus_
mutableprotected

Definition at line 96 of file rank.hh.

template<typename T>
argument mln::accu::stat::rank< T >::t_
mutableprotected

Definition at line 100 of file rank.hh.

template<typename T>
bool mln::accu::stat::rank< T >::valid_
mutableprotected

Definition at line 98 of file rank.hh.

Member Typedef Documentation

template<typename T>
typedef T mln::accu::stat::rank< T >::argument

Definition at line 62 of file rank.hh.

typedef Accumulator<void> mln::Accumulator< rank< T > >::category
inherited

Definition at line 64 of file accumulator.hh.

typedef rank< T > mln::Object< rank< T > >::exact_t
inherited

Definition at line 105 of file object.hh.

typedef const T & mln::accu::internal::base< const T & , rank< T > >::q_result
inherited

Definition at line 58 of file base.hh.

typedef mln::metal::unqualif< const T & >::ret mln::accu::internal::base< const T & , rank< T > >::result
inherited

Definition at line 59 of file base.hh.

template<typename T>
typedef mln::value::set<T> mln::accu::stat::rank< T >::S

Definition at line 63 of file rank.hh.