running_stat_vec< eT > Class Template Reference
[Running_stat_vec]

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_vec_proto.hpp>

List of all members.

Public Types

typedef get_pod_type< eT >
::pod_type 
T

Public Member Functions

 ~running_stat_vec ()
 running_stat_vec (const bool in_calc_cov=false)
template<typename T1 >
void operator() (const Base< T, T1 > &X)
 update statistics to reflect new sample
template<typename T1 >
void operator() (const Base< std::complex< T >, T1 > &X)
 update statistics to reflect new sample (version for complex numbers)
void reset ()
 set all statistics to zero
Mat< eT > mean () const
 mean or average value
Mat< Tvar (const u32 norm_type=0) const
 variance
Mat< Tstddev (const u32 norm_type=0) const
 standard deviation
Mat< eT > cov (const u32 norm_type=0) const
 covariance
Mat< eT > min () const
 vector with minimum values
Mat< eT > max () const
 vector with maximum values

Private Attributes

const bool calc_cov
arma_aligned arma_counter< Tcounter
arma_aligned Mat< eT > r_mean
arma_aligned Mat< Tr_var
arma_aligned Mat< eT > r_cov
arma_aligned Mat< eT > min_val
arma_aligned Mat< eT > max_val
arma_aligned Mat< Tmin_val_norm
arma_aligned Mat< Tmax_val_norm

Friends

class running_stat_vec_aux

Detailed Description

template<typename eT>
class running_stat_vec< 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 26 of file running_stat_vec_proto.hpp.


Member Typedef Documentation

template<typename eT>
typedef get_pod_type<eT>::pod_type running_stat_vec< eT >::T

Definition at line 30 of file running_stat_vec_proto.hpp.


Friends And Related Function Documentation

template<typename eT>
friend class running_stat_vec_aux [friend]

Definition at line 68 of file running_stat_vec_proto.hpp.


Member Data Documentation

template<typename eT>
const bool running_stat_vec< eT >::calc_cov [private]
template<typename eT>
arma_aligned arma_counter<T> running_stat_vec< eT >::counter [private]
template<typename eT>
arma_aligned Mat<eT> running_stat_vec< eT >::r_mean [private]
template<typename eT>
arma_aligned Mat< T> running_stat_vec< eT >::r_var [private]
template<typename eT>
arma_aligned Mat<eT> running_stat_vec< eT >::r_cov [private]
template<typename eT>
arma_aligned Mat<eT> running_stat_vec< eT >::min_val [private]
template<typename eT>
arma_aligned Mat<eT> running_stat_vec< eT >::max_val [private]
template<typename eT>
arma_aligned Mat< T> running_stat_vec< eT >::min_val_norm [private]

Definition at line 65 of file running_stat_vec_proto.hpp.

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

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

Definition at line 66 of file running_stat_vec_proto.hpp.

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