SimpleMovingAverage.hpp

//
// Created by Hamza El-Kebir on 6/15/21.
//
 
#ifndef LODESTAR_SIMPLEMOVINGAVERAGE_HPP
#define LODESTAR_SIMPLEMOVINGAVERAGE_HPP
 
#include "Lodestar/aux/ArrayStack.hpp"
 
namespace ls {
    namespace filter {
        template<typename TType = double, size_t TWindowSize = 1>
        class SimpleMovingAverage {
        public:
            typedef ls::aux::ArrayStack<TType, TWindowSize> TDWindow;
 
            SimpleMovingAverage() = default;
 
            void push(const TType &value)
            {
                window_.push(value);
            }
 
            TType average() const
            {
                // TODO: Repplace TType{} by StatusOr<TType>.
                TType ret{};
 
                if (window_.empty())
                    return ret;
 
                for (int i = 0; i < window_.size(); i++)
                    ret += window_[i];
 
                return ret / window_.size();
            }
 
            void clear() noexcept
            {
                window_.clear();
            }
 
            inline size_t size() const noexcept
            {
                return window_.size();
            }
 
            inline constexpr size_t max_size() const noexcept
            {
                return TWindowSize;
            }
 
        protected:
            TDWindow window_; 
        };
    }
}
 
#endif //LODESTAR_SIMPLEMOVINGAVERAGE_HPP