Add class to compute running average

STATUS: Builds

- Justin C

Signed-off-by: PhyXTGears <phyxtgearspro@gmail.com>

Author: PhyXTGears-1720

.vscode/settings.json

@@ -15,5 +15,6 @@
   "files.associations": {
     "*.inc": "cpp",
     "cmath": "cpp"
-  }
+  },
+  "C_Cpp.default.configurationProvider": "vscode-wpilib"
 }

gradlew

@@ -0,0 +1,37 @@
+
+#include "util/RunningAverage.h"
+
+template <class T>
+RunningAverage<T>::RunningAverage(size_t capacity)
+    : m_Capacity(capacity)
+    , m_Count(0)
+    , m_Index(0)
+    , m_Total(0.0)
+    , m_Average(0.0)
+{
+    m_Values = new T[capacity];
+}
+
+template <class T>
+RunningAverage<T>::~RunningAverage() {
+    delete m_Values;
+}
+
+template <class T>
+void RunningAverage<T>::PushValue(T val) {
+    m_Total -= m_Values[m_Index];
+    m_Total += val;
+
+    m_Values[m_Index] = val;
+    m_Count = std::min(m_Count, m_Capacity);
+    m_Index = (m_Index + 1) % m_Capacity;
+
+    if (0 < m_Count) {
+        m_Average = m_Total / m_Count;
+    }
+}
+
+template <class T>
+T RunningAverage<T>::GetAverage() {
+    return m_Average;
+}

src/main/cpp/util/RunningAverage.cpp

@@ -0,0 +1,25 @@
+#include <cstdlib>
+#include <algorithm>
+
+template <class T>
+class RunningAverage {
+public:
+    // Create an instance that stores the given number of elements.
+    RunningAverage(size_t);
+    ~RunningAverage();
+
+    // Push a value onto the ring buffer, and drop any extra values.
+    void PushValue(T);
+
+    // Return the value of the running average.
+    T GetAverage();
+
+private:
+    T *m_Values;
+    size_t m_Capacity;
+    size_t m_Count;
+    size_t m_Index;
+
+    T m_Total;
+    T m_Average;
+};