RollingMean Class Reference
A class that computes the mean over a series of data points. The window size determines the maximum number of data points. The oldest value is popped off when the window size is reached and a new value is pushed in. More...
#include <RollingMean.hh>
Public Member Functions | |
| RollingMean (size_t _windowSize=10) | |
| Constructor. | |
| void | Clear () |
| Remove all the pushed values. | |
| size_t | Count () const |
| Get the number of data points. | |
| double | Mean () const |
| Get the mean value. | |
| void | Push (double _value) |
| Insert a new value. | |
| void | SetWindowSize (size_t _windowSize) |
| Set the new window size. This will also clear the data. Nothing happens if the _windowSize is zero. | |
| size_t | WindowSize () const |
| Get the window size. | |
Detailed Description
A class that computes the mean over a series of data points. The window size determines the maximum number of data points. The oldest value is popped off when the window size is reached and a new value is pushed in.
Constructor & Destructor Documentation
◆ RollingMean()
|
explicit |
Constructor.
- Parameters
-
[in] _windowSize The window size to use. This value will be ignored if it is equal to zero.
Member Function Documentation
◆ Clear()
| void Clear | ( | ) |
Remove all the pushed values.
◆ Count()
| size_t Count | ( | ) | const |
Get the number of data points.
- Returns
- The number of datapoints.
◆ Mean()
| double Mean | ( | ) | const |
Get the mean value.
- Returns
- The current mean value, or std::numeric_limits<double>::quiet_NaN() if data points are not present.
◆ Push()
◆ SetWindowSize()
| void SetWindowSize | ( | size_t | _windowSize | ) |
Set the new window size. This will also clear the data. Nothing happens if the _windowSize is zero.
- Parameters
-
[in] _windowSize The window size to use.
◆ WindowSize()
| size_t WindowSize | ( | ) | const |
Get the window size.
- Returns
- The window size.
The documentation for this class was generated from the following file: