running_stat_vec< eT > Class Template Reference

#include <running_stat_vec_bones.hpp>

Public Types
typedef get_pod_type< eT >::result	T

Public Member Functions
T	count () const
	number of samples so far More...
const Mat< eT > &	cov (const uword norm_type=0)
	covariance More...
const Mat< eT > &	max () const
	vector with maximum values More...
const Mat< eT > &	mean () const
	mean or average value More...
const Mat< eT > &	min () const
	vector with minimum values More...
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)
template<typename T1 >
arma_hot void	operator() (const Base< typename get_pod_type< eT >::result, T1 > &X)
	update statistics to reflect new sample More...
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) More...
const running_stat_vec &	operator= (const running_stat_vec &in_rsv)
void	reset ()
	set all statistics to zero More...
	running_stat_vec (const bool in_calc_cov=false)
	running_stat_vec (const running_stat_vec &in_rsv)
Mat< T >	stddev (const uword norm_type=0) const
	standard deviation More...
const Mat< T > &	var (const uword norm_type=0)
	variance More...
	~running_stat_vec ()

Private Attributes
const bool	calc_cov
arma_aligned arma_counter< T >	counter
arma_aligned Mat< eT >	max_val
arma_aligned Mat< T >	max_val_norm
arma_aligned Mat< eT >	min_val
arma_aligned Mat< T >	min_val_norm
arma_aligned Mat< eT >	r_cov
arma_aligned Mat< eT >	r_cov_dummy
arma_aligned Mat< eT >	r_mean
arma_aligned Mat< T >	r_var
arma_aligned Mat< T >	r_var_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 24 of file running_stat_vec_bones.hpp.

Member Typedef Documentation

template<typename eT>

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

Definition at line 28 of file running_stat_vec_bones.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 78 of file running_stat_vec_bones.hpp.

Member Data Documentation

template<typename eT>

const bool running_stat_vec< eT >::calc_cov

private

Definition at line 58 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned arma_counter<T> running_stat_vec< eT >::counter

private

Definition at line 60 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat<eT> running_stat_vec< eT >::max_val

private

Definition at line 67 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat< T> running_stat_vec< eT >::max_val_norm

private

Definition at line 70 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat<eT> running_stat_vec< eT >::min_val

private

Definition at line 66 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat< T> running_stat_vec< eT >::min_val_norm

private

Definition at line 69 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat<eT> running_stat_vec< eT >::r_cov

private

Definition at line 64 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat<eT> running_stat_vec< eT >::r_cov_dummy

private

Definition at line 73 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat<eT> running_stat_vec< eT >::r_mean

private

Definition at line 62 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat< T> running_stat_vec< eT >::r_var

private

Definition at line 63 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat< T> running_stat_vec< eT >::r_var_dummy

private

Definition at line 72 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat<eT> running_stat_vec< eT >::tmp1

private

Definition at line 75 of file running_stat_vec_bones.hpp.

template<typename eT>

arma_aligned Mat<eT> running_stat_vec< eT >::tmp2

private

Definition at line 76 of file running_stat_vec_bones.hpp.

---

The documentation for this class was generated from the following files:

• running_stat_vec_bones.hpp
• running_stat_vec_meat.hpp