Develop (#27)

- update readme.md badges
- update examples
- add two step example
- minor edits

Author: RobTillaart

CHANGELOG.md

@@ -6,14 +6,20 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.4.4] - 2023-10-18
+- update readme.md badges
+- update examples
+- add two step example
+- minor edits
+
+
 ## [0.4.3] - 2022-11-23
 - add changelog.md
 - add RP2040 to build-CI
 - add examples
 - add getAverageSubset(start, count) - experimental
 - update readme.md
 
-
 ## [0.4.2] - 2021-12-28
 - update license
 - minor edits

README.md

@@ -2,8 +2,11 @@
 [![Arduino CI](https://github.com/RobTillaart/RunningAverage/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
 [![Arduino-lint](https://github.com/RobTillaart/RunningAverage/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/RunningAverage/actions/workflows/arduino-lint.yml)
 [![JSON check](https://github.com/RobTillaart/RunningAverage/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/RunningAverage/actions/workflows/jsoncheck.yml)
+[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/RunningAverage.svg)](https://github.com/RobTillaart/RunningAverage/issues)
+
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/RunningAverage/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/RunningAverage.svg?maxAge=3600)](https://github.com/RobTillaart/RunningAverage/releases)
+[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/RunningAverage.svg)](https://registry.platformio.org/libraries/robtillaart/RunningAverage)
 
 
 # RunningAverage
@@ -21,14 +24,31 @@ The size of the internal buffer can be set in the constructor.
 
 By keeping track of the **\_sum** the runningAverage can be calculated fast (only 1 division)
 at any time. This is done with **getFastAverage()**. 
-However the constant adding and subtracting when adding new elements possibly introduces an ever increasing error. 
+However the constant adding and subtracting when adding new elements to the RA object possibly 
+introduces an ever increasing error. 
 In tests adding up to 1500000 numbers this error was always small. But that is no proof.
 In version 0.2.16 a fix was added that uses the calculation of the sum in **getAverage()** to 
 update the internal **\_sum**.
 
 
+#### Related
+
+- https://github.com/RobTillaart/Correlation
+- https://github.com/RobTillaart/GST - Golden standard test metrics
+- https://github.com/RobTillaart/Histogram
+- https://github.com/RobTillaart/RunningAngle
+- https://github.com/RobTillaart/RunningAverage
+- https://github.com/RobTillaart/RunningMedian
+- https://github.com/RobTillaart/statHelpers - combinations & permutations
+- https://github.com/RobTillaart/Statistic
+
+
 ## Interface
 
+```cpp
+#include "RunningAverage.h"
+```
+
 ### Constructor
 
 - **RunningAverage(uint16_t size)** allocates dynamic memory, one float (4 bytes) per element. 
@@ -40,8 +60,10 @@ No default size (yet).
 
 - **void clear()** empties the internal buffer.
 - **void add(float value)** wrapper for **addValue()**
-- **void addValue(float value)** adds a new value to the object, if internal buffer is full, the oldest element is removed.
-- **void fillValue(float value, uint16_t number)**  adds number elements of value. Good for initializing the system to z certain starting average.
+- **void addValue(float value)** adds a new value to the object, if the internal buffer is full, 
+the oldest element is removed.
+- **void fillValue(float value, uint16_t number)**  adds number elements of value. 
+Good for initializing the system to a certain starting average.
 - **float getValue(uint16_t position)** returns the value at **position** from the additions. 
 Position 0 is the first one to disappear.
 - **float getAverage()** iterates over all elements to get the average, slower but accurate. 
@@ -68,15 +90,15 @@ Needs more than one element to be calculable.
 - **uint16_t getCount()** returns the number of slots used of the internal array.
 
 
-## Partial
+## Partial functions
 
 - **void setPartial(uint16_t partial = 0)** use only a part of the internal array. 
 Allows to change the weight and history factor. 
 0 ==> use all == default.
 - **uint16_t getPartial()** returns the set value for partial.
 
 
-## Last
+## Last functions
 
 These functions get the basic statistics of the last N added elements. 
 Returns NAN if there are no elements and it will reduce count if there are less than 
@@ -92,7 +114,7 @@ numbers of the whole buffer to notice changes earlier.
 Otherwise one should create multiple RunningAverage objects each with its own length, 
 effectively having multiple copies of the data added. 
 
-Note: if called with a value larger or equal to **getCount()**  (incl **getSize()**) as 
+Note: if called with a value larger or equal to **getCount()**  (including **getSize()**) as 
 parameter, the functions will return the statistics of the whole buffer. 
 
 
@@ -109,15 +131,40 @@ See examples
 
 ## Future 
 
-#### must
+
+#### Must
+
 - update documentation, explain better
 
-#### should
-- add error handling  (important?)
+#### Should
+
 - check for optimizations.
+  - divide by count happens often ...
 - clear(bool zero = true) to suppress setting all to 0. ?
 
-#### could
-- default size for constructor
+#### Could
+
 - create a double based derived class? Template class?
+- add error handling (important?).
+- investigate **modus()** most frequently occurring value.
+  - difficult with floats ?
+  - what to do when on two or more values are on par?
+
+#### Wont
+
+- default size for constructor
+  - unknown what would be a good choice.
+- clear(bool zero = true) to suppress setting all to 0. ?
+  - makes **addValue()** slightly more complex
+  - could introduce conflicts due to randomness data?
+
+
+## Support
+
+If you appreciate my libraries, you can support the development and maintenance.
+Improve the quality of the libraries by providing issues and Pull Requests, or
+donate through PayPal or GitHub sponsors.
+
+Thank you,
+
 

RunningAverage.cpp

@@ -1,8 +1,8 @@
 //
 //    FILE: RunningAverage.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.4.3
-//    DATE: 2015-July-10
+// VERSION: 0.4.4
+//    DATE: 2011-01-30
 // PURPOSE: Arduino library to calculate the running average by means of a circular buffer
 //     URL: https://github.com/RobTillaart/RunningAverage
 //
@@ -39,7 +39,7 @@ void RunningAverage::clear()
   _max = NAN;
   for (uint16_t i = _size; i > 0; )
   {
-    _array[--i] = 0.0; // keeps addValue simpler
+    _array[--i] = 0.0;  //  keeps addValue simpler
   }
 }
 
@@ -57,7 +57,7 @@ void RunningAverage::addValue(const float value)
   _sum += _array[_index];
   _index++;
 
-  if (_index == _partial) _index = 0;  // faster than %
+  if (_index == _partial) _index = 0;  //  faster than %
 
   //  handle min max
   if (_count == 0) _min = _max = value;
@@ -82,7 +82,7 @@ float RunningAverage::getAverage()
   {
     _sum += _array[i];
   }
-  return _sum / _count;   // multiplication is faster ==> extra admin
+  return _sum / _count;   //  multiplication is faster ==> extra admin
 }
 
 
@@ -246,10 +246,6 @@ void RunningAverage::setPartial(const uint16_t partial)
 }
 
 
-////////////////////////////////////////////////////////////////
-//
-//  0.4.1 added.
-//
 float RunningAverage::getAverageLast(uint16_t count)
 {
   uint16_t cnt = count;
@@ -308,11 +304,6 @@ float RunningAverage::getMaxInBufferLast(uint16_t count)
 }
 
 
-
-////////////////////////////////////////////////////////////////
-//
-//  Experimental 0.4.3
-//
 float RunningAverage::getAverageSubset(uint16_t start, uint16_t count)
 {
   if (_count == 0)
@@ -334,5 +325,5 @@ float RunningAverage::getAverageSubset(uint16_t start, uint16_t count)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

RunningAverage.h

@@ -1,17 +1,17 @@
 #pragma once
 //
 //    FILE: RunningAverage.h
-//  AUTHOR: Rob.Tillaart@gmail.com
-// VERSION: 0.4.3
-//    DATE: 2016-dec-01
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.4.4
+//    DATE: 2011-01-30
 // PURPOSE: Arduino library to calculate the running average by means of a circular buffer
 //     URL: https://github.com/RobTillaart/RunningAverage
 
 
 #include "Arduino.h"
 
 
-#define RUNNINGAVERAGE_LIB_VERSION    (F("0.4.3"))
+#define RUNNINGAVERAGE_LIB_VERSION    (F("0.4.4"))
 
 
 class RunningAverage
@@ -26,7 +26,7 @@ class RunningAverage
   void     fillValue(const float value, const uint16_t number);
   float    getValue(const uint16_t position);
 
-  float    getAverage();      //  iterates over all elements.
+  float    getAverage();            //  iterates over all elements.
   float    getFastAverage() const;  //  reuses previous calculated values.
 
   //  return statistical characteristics of the running average
@@ -76,5 +76,5 @@ class RunningAverage
 };
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

examples/fillValue/fillValue.ino

@@ -17,7 +17,7 @@ void setup(void)
 {
   Serial.begin(115200);
   Serial.print("Demo RunningAverage lib - fillValue ");
-  Serial.print("Version: ");
+  Serial.print("RUNNINGAVERAGE_LIB_VERSION: ");
   Serial.println(RUNNINGAVERAGE_LIB_VERSION);
   delay(10);
 
@@ -60,5 +60,5 @@ void measure_duration(int n)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

examples/ra_300/ra_300.ino

@@ -14,8 +14,9 @@ int samples = 0;
 void setup(void)
 {
   Serial.begin(115200);
-  Serial.println("Demo RunningAverage lib");
-  Serial.print("Version: ");
+  Serial.println();
+  Serial.println(__FILE__);
+  Serial.print("RUNNINGAVERAGE_LIB_VERSION: ");
   Serial.println(RUNNINGAVERAGE_LIB_VERSION);
 
   myRA.clear();
@@ -37,5 +38,5 @@ void loop(void)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

examples/ra_300_last/ra_300_last.ino

@@ -14,8 +14,9 @@ int samples = 0;
 void setup(void)
 {
   Serial.begin(115200);
-  Serial.println("Demo RunningAverage lib");
-  Serial.print("Version: ");
+  Serial.println();
+  Serial.println(__FILE__);
+  Serial.print("RUNNINGAVERAGE_LIB_VERSION: ");
   Serial.println(RUNNINGAVERAGE_LIB_VERSION);
 
   myRA.clear();
@@ -50,5 +51,5 @@ void loop(void)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

examples/ra_FastAverageTest/ra_FastAverageTest.ino

@@ -20,9 +20,9 @@ uint32_t start, stop;
 void setup(void)
 {
   Serial.begin(115200);
-  Serial.print("\nDemo ");
+  Serial.println();
   Serial.println(__FILE__);
-  Serial.print("Version: ");
+  Serial.print("RUNNINGAVERAGE_LIB_VERSION: ");
   Serial.println(RUNNINGAVERAGE_LIB_VERSION);
   myRA.clear(); // explicitly start clean
 
@@ -90,5 +90,5 @@ void test(long n)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

examples/ra_MinMaxBufferTest/ra_MinMaxBufferTest.ino

@@ -14,11 +14,11 @@ int samples = 0;
 void setup(void)
 {
   Serial.begin(115200);
-  Serial.print("\nDemo ");
+  Serial.println();
   Serial.println(__FILE__);
-  Serial.print("Version: ");
+  Serial.print("RUNNINGAVERAGE_LIB_VERSION: ");
   Serial.println(RUNNINGAVERAGE_LIB_VERSION);
-  myRA.clear(); // explicitly start clean
+  myRA.clear();  //  explicitly start clean
 
   Serial.println("\nCNT\tMIN\tMINBUF\tMAX\tMAXBUF");
 }
@@ -49,5 +49,5 @@ void loop(void)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --
 

examples/ra_MinMaxTest/ra_MinMaxTest.ino

@@ -14,10 +14,11 @@ int samples = 0;
 void setup(void)
 {
   Serial.begin(115200);
-  Serial.println("\nDemo runningAverageMinMaxTest");
-  Serial.print("Version: ");
+  Serial.println();
+  Serial.println(__FILE__);
+  Serial.print("RUNNINGAVERAGE_LIB_VERSION: ");
   Serial.println(RUNNINGAVERAGE_LIB_VERSION);
-  myRA.clear(); // explicitly start clean
+  myRA.clear();  //  explicitly start clean
 
   Serial.println("\nCNT\tMIN\tAVG\tMAX");
 }
@@ -46,5 +47,5 @@ void loop(void)
 }
 
 
-// -- END OF FILE --
+//  -- END OF FILE --