rolling_average.hpp

Go to the documentation of this file.

#ifndef BST_ROLLING_AVERAGE_HPP_
#define BST_ROLLING_AVERAGE_HPP_
 
#include <cstddef>
#include <queue>
 
namespace bst {
 
template <typename T = double>
class RollingAverage {
public:
  RollingAverage(size_t window_size) : window_size_(window_size) {
  }
 
  ~RollingAverage() = default;
 
  void addValue(T value) {
    queue_.push(value);
    sum_ += value;
 
    if (queue_.size() > window_size_) {
      sum_ -=
          queue_.front(); // remove the oldest transaction count from the sum
      queue_.pop();       // and the queue
    }
  }
 
  T getAverage() const {
    if (queue_.empty()) {
      return 0;
    }
 
    return static_cast<T>(sum_ / queue_.size());
  }
 
  void setWindowSize(size_t new_window_size) {
    window_size_ = new_window_size;
    while (queue_.size() > window_size_) {
      sum_ -= queue_.front();
      queue_.pop();
    }
  }
 
  void clear() {
    queue_ = {};
    sum_ = 0;
  }
 
  size_t getNumElements() const {
    return queue_.size();
  }
 
  size_t getWindowSize() const {
    return window_size_;
  }
 
  void removeOldest() {
    if (!queue_.empty()) {
      sum_ -= queue_.front();
      queue_.pop();
    }
  }
 
private:
  std::queue<T> queue_ = {};
  size_t window_size_;
  T sum_ = 0;
};
 
} // namespace bst
 
#endif /* ROLLING_AVERAGE_HPP_ */