MovingAverage.h

Go to the documentation of this file.

/*
 * MovingAverage.h
 *
 * Tool for moving averages.
 *
 * This file is part of Qualia https://github.com/sofian/qualia
 *
 * (c) 2011 Sofian Audry -- info(@)sofianaudry(.)com
 * Inspired by code by Karsten Kutza
 * http://www.ip-atlas.com/pub/nap/nn-src/bpn.txt
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef MOVINGAVERAGE_H_
#define MOVINGAVERAGE_H_

class MovingAverage {
  float _alpha;
  float _value;

public:
  MovingAverage(float startValue, float alphaOrN) : _value(startValue) {
    _alpha = (alphaOrN > 1 ?
        2 / (alphaOrN - 1) :
        alphaOrN);
  }

  void update(float v) {
    _value -= _alpha * (_value - v);
  }

  float get() const { return _value; }

  void reset(float startValue) {
    _value = startValue;
  }
};

#endif /* MOVINGAVERAGE_H_ */