JASPL  0.2
Just Another Signal Processing Library
Public Member Functions | List of all members
jaspl::RecurseMean< T > Class Template Reference

Average together a (nearly) arbitrary number of container-like objects using the recursive definition of the expected value defined by: More...

#include <jalgorithm.h>

Public Member Functions

 RecurseMean (uint num_samples)
 
void operator() (const T &next_value)
 Average together a new value. More...
 
void Reset ()
 
T::value_type Index ()
 
ReturnValue ()
 

Detailed Description

template<typename T>
class jaspl::RecurseMean< T >

Average together a (nearly) arbitrary number of container-like objects using the recursive definition of the expected value defined by:

\[ \mu_i = \frac{ i - 1 }{ i } \mu_{ i - 1 } + \frac{1}{i} x_i\\ \text{ for } x_i \in \mathbb{R}^n \ \mu_i \in \mathcal{R} \\ \text{ and running index } i \in \mathbb{N} \]

Template parameter needs to be a container-liker object filled with floating-point values.

Definition at line 34 of file jalgorithm.h.

Member Function Documentation

template<typename T >
void jaspl::RecurseMean< T >::operator() ( const T &  next_value)

Average together a new value.

Parameters
next_valueThe container to be averaged