fix avr boards compilation error and small performance improvements (#10

) * refactor(DataTomeMvAvg): 🎨 mean and count aliases now belongs to DataTomeMvAvg instead of DataTomeAnalysis Mean and count aliases now belongs to DataTomeMvAvg instead of DataTomeAnalysis. Comments were fixed to reflect the changes. keywords.txt was updated. * style(test): 🎨 fix typing case of DataTome instances on test code * refactor(DataTomeAnalysis): ⚡ improve calculation of method var * docs: 📝 update lib description * fix(DataTomeAnalysis): 🚑 fix var method miscalculation * docs: 📝 fix docs url file name * docs(readme): 🎨 improve readme style * docs(library_metadata): 📝 update library description * fix(DataTome): 🐛 fixed the library compiling issue on avr boards #12 * fix(DataTomeAnalysis): 🐛 fix qsort callback function
AlexandreHiroyuki · Aug 5, 2024 · 5ca50c8 · 5ca50c8
1 parent d0902ce
commit 5ca50c8
Show file tree

Hide file tree

Showing 15 changed files with 259 additions and 160 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,4 +14,7 @@ build/
 .idea/
 CMakeSettings.json
 
-.pio/
+# Local Build Test
+main.cpp
+
+.pio/
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,12 +1,63 @@
 {
   "files.associations": {
+    "*.postcss": "tailwindcss",
+    "*.svelte": "svelte",
+    "*.html": "html",
     "array": "cpp",
     "string_view": "cpp",
     "initializer_list": "cpp",
-    "utility": "cpp"
+    "utility": "cpp",
+    "atomic": "cpp",
+    "*.tcc": "cpp",
+    "cctype": "cpp",
+    "clocale": "cpp",
+    "cmath": "cpp",
+    "cstdarg": "cpp",
+    "cstddef": "cpp",
+    "cstdint": "cpp",
+    "cstdio": "cpp",
+    "cstdlib": "cpp",
+    "cstring": "cpp",
+    "ctime": "cpp",
+    "cwchar": "cpp",
+    "cwctype": "cpp",
+    "deque": "cpp",
+    "unordered_map": "cpp",
+    "unordered_set": "cpp",
+    "vector": "cpp",
+    "exception": "cpp",
+    "algorithm": "cpp",
+    "functional": "cpp",
+    "iterator": "cpp",
+    "map": "cpp",
+    "memory": "cpp",
+    "memory_resource": "cpp",
+    "numeric": "cpp",
+    "optional": "cpp",
+    "random": "cpp",
+    "string": "cpp",
+    "system_error": "cpp",
+    "tuple": "cpp",
+    "type_traits": "cpp",
+    "fstream": "cpp",
+    "iomanip": "cpp",
+    "iosfwd": "cpp",
+    "istream": "cpp",
+    "limits": "cpp",
+    "new": "cpp",
+    "ostream": "cpp",
+    "sstream": "cpp",
+    "stdexcept": "cpp",
+    "streambuf": "cpp",
+    "cinttypes": "cpp",
+    "typeinfo": "cpp"
   },
   "conventionalCommits.scopes": [
     "DataTomeAnalysis",
-    "DataTomeMvAvg"
+    "DataTomeMvAvg",
+    "test",
+    "readme",
+    "library_metadata",
+    "DataTome"
   ]
 }
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,6 +10,10 @@ Open an issue on the repository and provide the following information:
 2. What board and/or framework are you using?
 3. How can the issue be reproduced? Provide a minimal code snippet that reproduces the issue if possible.
 
+## Code Convention
+
+- Don't include C++ standard library functions, because it does not compile for AVR boards (C std libs still works). 
+
 ## Testing
 
 The library comes with a set of automated tests. Contributions should include tests to cover the new functionality and ensure that no regressions are introduced.

diff --git a/README.md b/README.md
@@ -10,12 +10,12 @@
 [![Top Language](https://img.shields.io/github/languages/top/AlexandreHiroyuki/DataTome)](https://github.com/AlexandreHiroyuki/DataTome)
 
 <p align="center">
-<img src="./docs/icon.png" width="128" height="128" />
+<img src="https://raw.githubusercontent.com/AlexandreHiroyuki/DataTome/main/docs/icon.png" width="128" height="128" />
 </p>
 
 ## Description
 
-Data Tome is a C++ library for data analysis and data filtering on IoT devices. Focus on the developer's experience and performance.
+Data Tome is a C++ library for data analysis and data filtering on embedded devices (IoT). Focus on the developer's experience and performance.
 
 ## Getting Started
 
@@ -28,14 +28,14 @@ Data Tome is a C++ library for data analysis and data filtering on IoT devices.
 
 This library calculates statistical functions using a time-series sample implemented with a circular array that improves the performance.
 
-> Online Docs: _[Click here to see the full documentation](https://alexandrehiroyuki.github.io/DataTomeDocs/)_
->
-> Docs GitHub Repository: _[The documentation is coded with docusaurus, and you can visit the repository](https://github.com/AlexandreHiroyuki/DataTomeDocs)_
+- Online Docs: _[Click here to see the full documentation](https://alexandrehiroyuki.github.io/DataTomeDocs/)_
+
+- Docs GitHub Repository: _[The documentation is coded with docusaurus, and you can visit the repository](https://github.com/AlexandreHiroyuki/DataTomeDocs)_
 
 ## Contributing
 
 [Read here how to contribute](https://github.com/AlexandreHiroyuki/DataTome/blob/master/CONTRIBUTING.md).
 
 ## Developed by
 
-**Alexandre Hiroyuki** – [GitHub](https://github.com/AlexandreHiroyuki) – [LinkedIn](https://www.linkedin.com/in/alexandre-hiroyuki-yamauchi-7137241a6/)
+**Alexandre Hiroyuki** – [GitHub](https://github.com/AlexandreHiroyuki) – [LinkedIn](https://www.linkedin.com/in/alexandre-hiroyuki-yamauchi/)
diff --git a/docs/MovingAveragePlus Docs.url → docs/DataTomeDocs.url b/docs/MovingAveragePlus Docs.url → docs/DataTomeDocs.url
diff --git a/keywords.txt b/keywords.txt
@@ -17,28 +17,43 @@ DataTomeAnalysis	KEYWORD1
 push	KEYWORD2
 get	KEYWORD2
 get_by_brute	KEYWORD2
+mean	KEYWORD2
 
 front	KEYWORD2
 back	KEYWORD2
 
 atIndex	KEYWORD2
 size	KEYWORD2
 point_count	KEYWORD2
+count	KEYWORD2
 
+grow	KEYWORD2
 resize	KEYWORD2
 clear	KEYWORD2
 
 partial_create	KEYWORD2
 partial_get	KEYWORD2
+partial_mean	KEYWORD2
 partial_size	KEYWORD2
 partial_point_count	KEYWORD2
+partial_count	KEYWORD2
 
 #######################################
 # Methods and Functions (KEYWORD2)
 # DataTomeAnalysis
 #######################################
 
+min	KEYWORD2
+max	KEYWORD2
+median	KEYWORD2
+lowest_mode	KEYWORD2
+highest_mode	KEYWORD2
 std	KEYWORD2
 var	KEYWORD2
+partial_min	KEYWORD2
+partial_max	KEYWORD2
+partial_median	KEYWORD2
+partial_lowest_mode	KEYWORD2
+partial_highest_mode	KEYWORD2
 partial_var	KEYWORD2
 partial_std	KEYWORD2
diff --git a/library.json b/library.json
@@ -1,8 +1,8 @@
 {
     "$schema": "https://raw.githubusercontent.com/platformio/platformio-core/develop/platformio/assets/schema/library.json",
     "name": "DataTome",
-    "version": "1.6.3",
-    "description": "Data Tome is a C++ library for data analysis and data filtering on IoT devices. Focus on the developer's experience and performance.",
+    "version": "1.7.0",
+    "description": "Data analysis and filtering using time series for embedded devices (IoT). All in a single C++ library, Data Tome. Focus on the developer's experience and performance.",
     "keywords": "sensors, input, data, processing, analysis, arduino, library, filter, moving average, smooth, standard, deviation, mean, partial, tome, datatome",
     "repository": {
         "type": "git",
@@ -43,7 +43,9 @@
     ],
     "export": {
         "exclude": [
-            ".github"
+            ".github",
+            ".gitignore",
+            ".vscode"
         ]
     },
     "srcDir": "src"

diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
 name=DataTome
-version=1.6.3
+version=1.7.0
 author=Alexandre Hiroyuki Yamauchi <alex.hiroyuki@outlook.com>
 maintainer=Alexandre Hiroyuki Yamauchi <alex.hiroyuki@outlook.com>
-sentence=Moving Average and other statistical functions compatible with any number type.
-paragraph=Fully documented. Data Tome is a C++ library for data analysis and data filtering on IoT devices. Focus on the developer experience and performance.
+sentence=Data analysis and filtering using time series for embedded devices (IoT). All in a single C++ library, Data Tome.
+paragraph=Fully documented. Focus on the developer's experience and performance.
 category=Data Processing
 url=https://github.com/AlexandreHiroyuki/DataTome
 architectures=*
diff --git a/platformio.ini b/platformio.ini
@@ -13,7 +13,12 @@ platform = espressif32
 board = esp32dev
 framework = arduino
 
+[env:arduino_avr]
+framework = arduino
+platform = atmelavr
+board = uno
+
 [env:desktop]
 platform = native
-build_flags =
-    -D unitTesting
+build_flags = -D unitTesting
+build_type = test
diff --git a/src/DataTome.h b/src/DataTome.h
@@ -9,5 +9,6 @@
 
 #include <DataTomeAnalysis.h>
 #include <DataTomeMvAvg.h>
+#include <DataTomeUtils.h>
 
 #endif  // DATA_TOME_H
diff --git a/src/DataTomeAnalysis.h b/src/DataTomeAnalysis.h
@@ -8,39 +8,31 @@
 #define DATA_TOME_ANALYSIS_H
 
 #include <DataTomeMvAvg.h>
-
-#include <algorithm>
-#include <cmath>
-#include <cstdlib>
+#include <DataTomeUtils.h>
+#include <math.h>
+#include <stdlib.h>
 
 template <typename TypeOfArray, typename TypeOfSum = TypeOfArray>
 class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
  public:
   DataTomeAnalysis(size_t size) : DataTomeMvAvg<TypeOfArray, TypeOfSum>(size) {}
 
-  /** Aliases **/
-
-  TypeOfArray mean() { return this->get(); }
-  size_t count() { return this->point_count(); }
-
-  /** Proper Methods **/
-
-  TypeOfArray min() {
-    TypeOfArray min = (*this)[0];
+  TypeOfArray minimum() {
+    TypeOfArray result = (*this)[0];
     for (size_t i = 1; i < this->point_count(); i++) {
-      if ((*this)[i] < min) min = (*this)[i];
+      if ((*this)[i] < result) result = (*this)[i];
     }
 
-    return min;
+    return result;
   }
 
-  TypeOfArray max() {
-    TypeOfArray max = (*this)[0];
+  TypeOfArray maximum() {
+    TypeOfArray result = (*this)[0];
     for (size_t i = 1; i < this->point_count(); i++) {
-      if ((*this)[i] > max) max = (*this)[i];
+      if ((*this)[i] > result) result = (*this)[i];
     }
 
-    return max;
+    return result;
   }
 
   TypeOfArray median() {
@@ -52,7 +44,7 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
 
     memcpy(temp, this->_array, current_size * sizeof(TypeOfArray));
 
-    std::sort(temp, temp + current_size);
+    qsort(temp, current_size, sizeof(TypeOfArray), sort_ascend<TypeOfArray>);
 
     if (current_size % 2 == 0) {
       median = (temp[current_size / 2 - 1] + temp[current_size / 2]) / 2;
@@ -73,7 +65,7 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
 
     memcpy(temp, this->_array, current_size * sizeof(TypeOfArray));
 
-    std::sort(temp, temp + current_size);
+    qsort(temp, current_size, sizeof(TypeOfArray), sort_ascend<TypeOfArray>);
 
     size_t max_count = 0;
     TypeOfArray mode = temp[0];
@@ -108,7 +100,7 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
 
     memcpy(temp, this->_array, current_size * sizeof(TypeOfArray));
 
-    std::sort(temp, temp + current_size);
+    qsort(temp, current_size, sizeof(TypeOfArray), sort_ascend<TypeOfArray>);
 
     size_t max_count = 0;
     TypeOfArray mode = temp[0];
@@ -140,7 +132,8 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
 
     TypeOfArray var = 0;
     for (size_t i = 0; i < this->point_count(); i++) {
-      var += ((*this)[i] - average) * ((*this)[i] - average);
+      TypeOfArray data_point = (*this)[i] - average;
+      var += (data_point) * (data_point);
     }
 
     return var;
@@ -150,33 +143,22 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
 
   /** Partial Methods **/
 
-  /** Aliases **/
-
-  TypeOfArray partial_mean(size_t partial_id) {
-    return this->partial_get(partial_id);
-  }
-  size_t partial_count(size_t partial_id) {
-    return this->partial_size(partial_id);
-  }
-
-  /** Proper Methods **/
-
-  TypeOfArray partial_min(size_t partial_id) {
-    TypeOfArray min = (*this)[0];
+  TypeOfArray partial_minimum(size_t partial_id) {
+    TypeOfArray result = (*this)[0];
     for (size_t i = 1; i < this->partial_point_count(partial_id); i++) {
-      if ((*this)[i] < min) min = (*this)[i];
+      if ((*this)[i] < result) result = (*this)[i];
     }
 
-    return min;
+    return result;
   }
 
-  TypeOfArray partial_max(size_t partial_id) {
-    TypeOfArray max = (*this)[0];
+  TypeOfArray partial_maximum(size_t partial_id) {
+    TypeOfArray result = (*this)[0];
     for (size_t i = 1; i < this->partial_point_count(partial_id); i++) {
-      if ((*this)[i] > max) max = (*this)[i];
+      if ((*this)[i] > result) result = (*this)[i];
     }
 
-    return max;
+    return result;
   }
 
   TypeOfArray partial_median(size_t partial_id) {
@@ -190,7 +172,7 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
       temp[i] = (*this)[i];
     }
 
-    std::sort(temp, temp + current_size);
+    qsort(temp, current_size, sizeof(TypeOfArray), sort_ascend<TypeOfArray>);
 
     if (current_size % 2 == 0) {
       median = (temp[current_size / 2 - 1] + temp[current_size / 2]) / 2;
@@ -213,7 +195,7 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
       temp[i] = (*this)[i];
     }
 
-    std::sort(temp, temp + current_size);
+    qsort(temp, current_size, sizeof(TypeOfArray), sort_ascend<TypeOfArray>);
 
     size_t max_count = 0;
     TypeOfArray mode = temp[0];
@@ -250,7 +232,7 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
       temp[i] = (*this)[i];
     }
 
-    std::sort(temp, temp + current_size);
+    qsort(temp, current_size, sizeof(TypeOfArray), sort_ascend<TypeOfArray>);
 
     size_t max_count = 0;
     TypeOfArray mode = temp[0];
@@ -282,7 +264,8 @@ class DataTomeAnalysis : public DataTomeMvAvg<TypeOfArray, TypeOfSum> {
 
     TypeOfArray var = 0;
     for (size_t i = 0; i < this->partial_point_count(partial_id); i++) {
-      var += ((*this)[i] - average) * ((*this)[i] - average);
+      TypeOfArray data_point = (*this)[i] - average;
+      var += (data_point) * (data_point);
     }
 
     return var;