running_stat< eT > Class Template Reference

#include <running_stat_bones.hpp>

List of all members.

Public Types
typedef get_pod_type< eT >::result	T
Public Member Functions
T	count () const
	number of samples so far
eT	max () const
	maximum value
eT	mean () const
	mean or average value
eT	min () const
	minimum value
void	operator() (const T sample)
void	operator() (const std::complex< T > &sample)
void	reset ()
	set all statistics to zero
	running_stat ()
T	stddev (const uword norm_type=0) const
	standard deviation
T	var (const uword norm_type=0) const
	variance
	~running_stat ()
Private Attributes
arma_aligned arma_counter< T >	counter
arma_aligned eT	max_val
arma_aligned T	max_val_norm
arma_aligned eT	min_val
arma_aligned T	min_val_norm
arma_aligned eT	r_mean
arma_aligned T	r_var
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 49 of file running_stat_bones.hpp.

---

Member Typedef Documentation

template<typename eT>

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

Definition at line 53 of file running_stat_bones.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 91 of file running_stat_bones.hpp.

---

Member Data Documentation

template<typename eT>

arma_aligned arma_counter<T> running_stat< eT >::counter [private]

Definition at line 79 of file running_stat_bones.hpp.

template<typename eT>

arma_aligned eT running_stat< eT >::max_val [private]

Definition at line 85 of file running_stat_bones.hpp.

template<typename eT>

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

Definition at line 88 of file running_stat_bones.hpp.

template<typename eT>

arma_aligned eT running_stat< eT >::min_val [private]

Definition at line 84 of file running_stat_bones.hpp.

template<typename eT>

arma_aligned T running_stat< eT >::min_val_norm [private]

Definition at line 87 of file running_stat_bones.hpp.

template<typename eT>

arma_aligned eT running_stat< eT >::r_mean [private]

Definition at line 81 of file running_stat_bones.hpp.

template<typename eT>

arma_aligned T running_stat< eT >::r_var [private]

Definition at line 82 of file running_stat_bones.hpp.

---

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

• running_stat_bones.hpp
• running_stat_meat.hpp