MovingAverage Class Reference

#include <Controller.h>

Public Member Functions
	MovingAverage (int mws=20)
void	reset (int mws=20)
void	addSample (double x)
double	average () const

Detailed Description

Maintain moving window average for a collection of samples. Samples contained in a circular queue (newest replacing oldest) implemented using a fixed length vector. Average is updated for each new sample with O(1) work.

Definition at line 46 of file Controller.h.

Constructor & Destructor Documentation

MovingAverage()

MovingAverage::MovingAverage ( int  mws = 20 )

inline

Definition at line 53 of file Controller.h.

                              : a(0), n(0), i(0), m(mws) {
    sample.resize(m);
  }

Member Function Documentation

addSample()

void MovingAverage::addSample ( double  x )

inline

Definition at line 63 of file Controller.h.

Referenced by Controller::printEnergies().

                           {
    if (n < m) {  // use running average formula
      sample[i] = x;
      // XXX I think that the index increment below is faster than
      // i = (i+1) % m due to avoiding an integer division
      i = (i < m-1 ? i+1 : 0);  // increment i to next available slot
      double a_old = a;
      n++;
      a = a_old + (x - a_old) / n;
    }
    else {  // use update average formula
      double x_old = sample[i];
      sample[i] = x;
      i = (i < m-1 ? i+1 : 0);  // increment i to next available slot
      a = a + (x - x_old) / n;
    }
  }

average()

double MovingAverage::average ( ) const

inline

Definition at line 80 of file Controller.h.

Referenced by Controller::printEnergies().

{ return a; }

reset()

void MovingAverage::reset ( int  mws = 20 )

inline

Definition at line 56 of file Controller.h.

Referenced by Controller::resetMovingAverage().

                           {
    a=0, n=0, i=0;
    if (m != mws) {
      m = mws;
      sample.resize(m);
    }
  }

---

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

• Controller.h