MovingAverage.hpp

Go to the documentation of this file.

#pragma once

#include "FlingTypes.h"

namespace Fling
{
    template<typename T, size_t t_Size>
    class MovingAverage
    {
    public:
        
        MovingAverage();
        ~MovingAverage() = default;

        void Push(T t_Element);

        T GetAverage() const;
    
    private:
        size_t m_CurrentIndex = {};

        size_t m_Count = {};
        
        size_t m_MaxSize = {};

        T m_Buffer [t_Size] = {};
    };

    template<typename T, size_t t_Size>
    inline MovingAverage<T, t_Size>::MovingAverage()
        : m_MaxSize(t_Size)
    {
    }

    template<typename T, size_t t_Size>
    inline void MovingAverage<T, t_Size>::Push(T t_Element)
    {
        ++m_Count;
        const UINT32 index = m_CurrentIndex++;
        m_Buffer[index & (m_MaxSize - 1u)] = t_Element;
    }

    template<typename T, size_t t_Size>
    inline T MovingAverage<T, t_Size>::GetAverage() const
    {
        T Average = {};

        size_t Range = (m_Count < m_MaxSize ? m_Count : m_MaxSize);
        for (size_t i = 0; i < Range; ++i)
        {
            Average += m_Buffer[i];
        }

        return (Average / static_cast<T>(Range));
    }
}   // namespace Fling