qxLib
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
qx::moving_average< T > Class Template Reference

Moving average is the unweighted mean of the previous K entries. More...

#include <moving_average.h>

Public Member Functions

 moving_average (size_t nEntries, T startValue, moving_average_weights_func< T > func=get_moving_average_simple_weights< T >)
 moving_average object constructor More...
 
update (T value)
 Update moving average. More...
 
get () const
 Get current moving average. More...
 
size_t get_num_entries () const
 Get number of entries in average calc. More...
 

Detailed Description

template<class T>
class qx::moving_average< T >

Moving average is the unweighted mean of the previous K entries.

See also
https://tinyurl.com/d3nfcaca to compare weights filling funcs blue - random numbers [-5, 5] green - get_moving_average_simple_weights yellow - get_moving_average_linear_weights red - get_moving_average_exp_weights with ALPHA = 0.8f
Template Parameters
T- floating point ish type
Author
Khrapov
Date
1.06.2021

Definition at line 66 of file moving_average.h.

Constructor & Destructor Documentation

◆ moving_average()

template<class T >
qx::moving_average< T >::moving_average ( size_t  nEntries,
startValue,
moving_average_weights_func< T >  func = get_moving_average_simple_weights<T> 
)
inline

moving_average object constructor

Parameters
nEntries- number of entries in average calc
startValue- start value
func- weights func

Definition at line 49 of file moving_average.inl.

Member Function Documentation

◆ get()

template<class T >
T qx::moving_average< T >::get
inline

Get current moving average.

Return values
-current moving average

Definition at line 70 of file moving_average.inl.

◆ get_num_entries()

template<class T >
size_t qx::moving_average< T >::get_num_entries
inline

Get number of entries in average calc.

Return values
-number of entries in average calc

Definition at line 76 of file moving_average.inl.

◆ update()

template<class T >
T qx::moving_average< T >::update ( value)
inline

Update moving average.

Parameters
value- new value
Return values
-new moving average

Definition at line 57 of file moving_average.inl.


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