Public Types | Public Member Functions | Private Attributes | Friends

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 >::result T

Public Member Functions

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

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
arma_aligned Mat< Tr_var_dummy
arma_aligned Mat< eT > r_cov_dummy
arma_aligned Mat< eT > tmp1
arma_aligned Mat< eT > tmp2

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 27 of file running_stat_vec_proto.hpp.


Member Typedef Documentation

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

Definition at line 31 of file running_stat_vec_proto.hpp.


Member Function Documentation

template<typename eT>
template<typename T1 >
arma_hot void running_stat_vec< eT >::operator() ( const Base< T, T1 > &  X  )  [inline]
template<typename eT>
template<typename T1 >
arma_hot void running_stat_vec< eT >::operator() ( const Base< std::complex< T >, T1 > &  X  )  [inline]

Friends And Related Function Documentation

template<typename eT>
friend class running_stat_vec_aux [friend]

Definition at line 79 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]
template<typename eT>
arma_aligned Mat< T> running_stat_vec< eT >::max_val_norm [private]
template<typename eT>
arma_aligned Mat< T> running_stat_vec< eT >::r_var_dummy [private]
template<typename eT>
arma_aligned Mat<eT> running_stat_vec< eT >::r_cov_dummy [private]
template<typename eT>
arma_aligned Mat<eT> running_stat_vec< eT >::tmp1 [private]
template<typename eT>
arma_aligned Mat<eT> running_stat_vec< eT >::tmp2 [private]