Torc  0.1
Public Member Functions | List of all members
TorcAverage< T > Class Template Reference

Compute a running average. More...

#include <torcmaths.h>

Public Member Functions

 TorcAverage (int MaxCount=0)
 
double AddValue (T Value)
 
double GetAverage (void)
 
void Reset (void)
 

Detailed Description

template<typename T>
class TorcAverage< T >

Compute a running average.

If MaxCount is set, the average will be limited to MaxCount number of most recent samples.

Definition at line 11 of file torcmaths.h.

Constructor & Destructor Documentation

template<typename T>
TorcAverage< T >::TorcAverage ( int  MaxCount = 0)
inlineexplicit

Definition at line 14 of file torcmaths.h.

Member Function Documentation

template<typename T>
double TorcAverage< T >::AddValue ( Value)
inline

Definition at line 22 of file torcmaths.h.

template<typename T>
double TorcAverage< T >::GetAverage ( void  )
inline

Definition at line 38 of file torcmaths.h.

template<typename T>
void TorcAverage< T >::Reset ( void  )
inline

Definition at line 43 of file torcmaths.h.


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