Public Types | Public Member Functions | Private Attributes | Friends

running_stat< eT > Class Template Reference
[Running_stat]

Class for keeping statistics of a continuously sampled process / signal. //! Useful if the storage of individual samples is not necessary or desired. //! Also useful if the number of samples is not known beforehand or exceeds //! available memory. More...

#include <running_stat_proto.hpp>

List of all members.

Public Types

typedef get_pod_type< eT >::result T

Public Member Functions

 ~running_stat ()
 running_stat ()
void operator() (const T sample)
void operator() (const std::complex< T > &sample)
void reset ()
 set all statistics to zero
eT mean () const
 mean or average value
T var (const u32 norm_type=0) const
 variance
T stddev (const u32 norm_type=0) const
 standard deviation
eT min () const
 minimum value
eT max () const
 maximum value

Private Attributes

arma_aligned arma_counter< Tcounter
arma_aligned eT r_mean
arma_aligned T r_var
arma_aligned eT min_val
arma_aligned eT max_val
arma_aligned T min_val_norm
arma_aligned T max_val_norm

Friends

class running_stat_aux

Detailed Description

template<typename eT>
class running_stat< eT >

Class for keeping statistics of a continuously sampled process / signal. //! Useful if the storage of individual samples is not necessary or desired. //! Also useful if the number of samples is not known beforehand or exceeds //! available memory.

Definition at line 52 of file running_stat_proto.hpp.


Member Typedef Documentation

template<typename eT>
typedef get_pod_type<eT>::result running_stat< eT >::T

Definition at line 56 of file running_stat_proto.hpp.


Member Function Documentation

template<typename eT>
void running_stat< eT >::operator() ( const T  sample  )  [inline]
template<typename eT>
void running_stat< eT >::operator() ( const std::complex< T > &  sample  )  [inline]

Friends And Related Function Documentation

template<typename eT>
friend class running_stat_aux [friend]

Definition at line 92 of file running_stat_proto.hpp.


Member Data Documentation

template<typename eT>
arma_aligned arma_counter<T> running_stat< eT >::counter [private]
template<typename eT>
arma_aligned eT running_stat< eT >::r_mean [private]
template<typename eT>
arma_aligned T running_stat< eT >::r_var [private]
template<typename eT>
arma_aligned eT running_stat< eT >::min_val [private]
template<typename eT>
arma_aligned eT running_stat< eT >::max_val [private]
template<typename eT>
arma_aligned T running_stat< eT >::min_val_norm [private]

Definition at line 88 of file running_stat_proto.hpp.

Referenced by running_stat< eT >::reset().

template<typename eT>
arma_aligned T running_stat< eT >::max_val_norm [private]

Definition at line 89 of file running_stat_proto.hpp.

Referenced by running_stat< eT >::reset().