feat(DataTomeExpAvg): ✨ add DataTomeExpAvg with unit tests

#9 #19

.vscode/settings.json

@@ -58,6 +58,8 @@
     "test",
     "readme",
     "library_metadata",
-    "DataTome"
+    "DataTome",
+    "DataTomeCumulative",
+    "DataTomeExpAvg"
   ]
 }

build_test.cpp

@@ -4,12 +4,13 @@
 
 // Create an Arithmetic Moving Average object of unsigned int type,
 // 10 in size
-DataTomeMvAvg<unsigned, unsigned long> test(10);
-DataTomeAnalysis<unsigned, unsigned long> test2(10);
-// DataTomeExpAvg<unsigned, unsigned long> test3(10);
+DataTomeMvAvg<int, long int> test(10);
+DataTomeAnalysis<int, long int> test2(10);
+DataTomeCumulative<double> test3;
+DataTomeExpAvg<double> test4;
 
 // This variable just generates input for average test
-unsigned delta_x = 0;
+int delta_x = 0;
 
 void setup() {
   // Initialize serial interface
@@ -19,9 +20,12 @@ void setup() {
 void loop() {
   // Pushes the input in the moving average object
   test.push(delta_x);
+  test2.push(delta_x);
+  test3.push(delta_x);
+  test4.push(delta_x);
 
   // Generates the next input
-  delta_x += 5;
+  delta_x += 3;
   if (delta_x > 1000) delta_x = 0;
 
   // Prints each value stored in the moving average
@@ -38,5 +42,18 @@ void loop() {
   Serial.print(" b: ");
   Serial.println(test.back());
 
+  Serial.print("Analysis: ");
+  Serial.print(test2.mean());
+  Serial.print(" | Std: ");
+  Serial.print(test2.std());
+  Serial.print(" | Median: ");
+  Serial.println(test2.median());
+
+  Serial.print("Cumulative: ");
+  Serial.println(test3.get());
+
+  Serial.print(" | ExpAvg: ");
+  Serial.println(test4.get());
+
   delay(1000);
 }

library.json

@@ -22,8 +22,11 @@
     "platforms": "*",
     "headers": [
         "DataTome.h",
+        "DataTomeAnalysis.h",
+        "DataTomeCumulative.h",
+        "DataTomeExpAvg",
         "DataTomeMvAvg.h",
-        "DataTomeAnalysis.h"
+        "DataTomeUtils.h"
     ],
     "examples": [
         {
@@ -43,9 +46,12 @@
     ],
     "export": {
         "exclude": [
+            "test/",
             ".github",
             ".gitignore",
-            ".vscode"
+            ".vscode",
+            "build_test.cpp",
+            "docs/icon.png"
         ]
     },
     "srcDir": "src"

src/DataTome.h

@@ -9,6 +9,7 @@
 
 #include <DataTomeAnalysis.h>
 #include <DataTomeCumulative.h>
+#include <DataTomeExpAvg.h>
 #include <DataTomeMvAvg.h>
 #include <DataTomeUtils.h>
 

src/DataTomeCumulative.h

@@ -8,8 +8,9 @@
 
 #include <limits.h>
 
-// WARNING: using this class with integer types may result in loss of precision
-// due to cumulative integer divisions rounding.
+// RECOMMENDED: use double type for TypeOfSum
+// WARNING: using this class with integer types may result in a loss of
+// precision due to cumulative rounding of integer divisions.
 template <typename TypeOfSum>
 class DataTomeCumulative {
  protected:
@@ -24,10 +25,10 @@ class DataTomeCumulative {
       _cumulative_average = 0;
       _count = 0;
     }
+    _count++;
 
-    _cumulative_average += (input - _cumulative_average) / (_count + 1);
+    _cumulative_average += (input - _cumulative_average) / (_count);
 
-    _count++;
     return *this;
   }
 

src/DataTomeExpAvg.h

@@ -0,0 +1,39 @@
+/***************************************************************
+  DataTomeExpAvg.h
+  Created by Alexandre Hiroyuki Yamauchi, August 19, 2024.
+***************************************************************/
+
+#ifndef DATA_TOME_EXP_AVG_H
+#define DATA_TOME_EXP_AVG_H
+
+#include <limits.h>
+
+// RECOMMENDED: use double type for TypeOfSum
+// WARNING: using this class with integer types may result in a loss of
+// precision due to cumulative rounding of integer divisions.
+template <typename TypeOfSum>
+class DataTomeExpAvg {
+ protected:
+  TypeOfSum _exp_avg;
+  unsigned long int _count;
+
+ public:
+  DataTomeExpAvg() : _exp_avg(0), _count(0) {}
+
+  DataTomeExpAvg<TypeOfSum> &push(TypeOfSum input) {
+    if (_count >= ULONG_MAX) {
+      _exp_avg = 0;
+      _count = 0;
+    }
+    _count++;
+
+    TypeOfSum multiplier = 2 / (_count);
+    _exp_avg = (input * multiplier) + (_exp_avg * (1 - multiplier));
+
+    return *this;
+  }
+
+  TypeOfSum get() { return _exp_avg; }
+};
+
+#endif  // DATA_TOME_EXP_AVG_H

test/test_DataTomeCumulative/DataTomeCumulative.test.cpp

@@ -0,0 +1,52 @@
+#include <DataTomeCumulative.h>
+#include <stdio.h>
+#include <unity.h>
+
+void setUp(void) {}  // before test
+
+void tearDown(void) {}  // after test
+
+void test_getCumulativeAverage(void) {
+  DataTomeCumulative<double> testMV;
+
+  testMV.push(1);
+  testMV.push(2);
+  testMV.push(3);
+
+  TEST_ASSERT_EQUAL(2, testMV.get());
+}
+
+void process() {
+  UNITY_BEGIN();
+
+  RUN_TEST(test_getCumulativeAverage);
+
+  UNITY_END();
+}
+
+#ifdef ARDUINO
+
+#include <Arduino.h>
+void setup() {
+  // NOTE!!! Wait for >2 secs
+  // if board doesn't support software reset via Serial.DTR/RTS
+  delay(2000);
+
+  process();
+}
+
+void loop() {
+  digitalWrite(13, HIGH);
+  delay(200);
+  digitalWrite(13, LOW);
+  delay(200);
+}
+
+#else
+
+int main(int argc, char **argv) {
+  process();
+  return 0;
+}
+
+#endif

test/test_DataTomeExpAvg/DataTomeExpAvg.test.cpp

@@ -0,0 +1,51 @@
+#include <DataTomeExpAvg.h>
+#include <unity.h>
+
+void setUp(void) {}  // before test
+
+void tearDown(void) {}  // after test
+
+void test_getExpAverage(void) {
+  DataTomeExpAvg<double> testMV;
+
+  testMV.push(1);
+  testMV.push(2);
+  testMV.push(3);
+
+  TEST_ASSERT_EQUAL(2, testMV.get());
+}
+
+void process() {
+  UNITY_BEGIN();
+
+  RUN_TEST(test_getExpAverage);
+
+  UNITY_END();
+}
+
+#ifdef ARDUINO
+
+#include <Arduino.h>
+void setup() {
+  // NOTE!!! Wait for >2 secs
+  // if board doesn't support software reset via Serial.DTR/RTS
+  delay(2000);
+
+  process();
+}
+
+void loop() {
+  digitalWrite(13, HIGH);
+  delay(200);
+  digitalWrite(13, LOW);
+  delay(200);
+}
+
+#else
+
+int main(int argc, char **argv) {
+  process();
+  return 0;
+}
+
+#endif