+ version 0.2.08

+ refactored getMin() and getMax() + fixed typos + added demo sketch getMin getMax

Author: RobTillaart

libraries/RunningAverage/RunningAverage.cpp

@@ -1,8 +1,8 @@
 //
 // FILE: RunningAverage.cpp
 // AUTHOR: Rob Tillaart
-// VERSION: 0.2.07
-// DATE: 2015-mar-16
+// VERSION: 0.2.08
+// DATE: 2015-apr-10
 // PURPOSE: RunningAverage library for Arduino
 //
 // The library stores N individual values in a circular buffer,
@@ -19,7 +19,8 @@
 // 0.2.04 - 2014-07-03 added memory protection
 // 0.2.05 - 2014-12-16 changed float -> double
 // 0.2.06 - 2015-03-07 all size uint8_t
-// 0.2.07 - 2015-03-16 added getMin() and getMax() functions
+// 0.2.07 - 2015-03-16 added getMin() and getMax() functions (Eric Mulder)
+// 0.2.08 - 2015-04-10 refactored getMin() and getMax() implementation
 //
 // Released to the public domain
 //
@@ -33,8 +34,6 @@ RunningAverage::RunningAverage(uint8_t size)
  _ar = (double*) malloc(_size * sizeof(double));
  if (_ar == NULL) _size = 0;
  clear();
-_min = NAN;
-_max = NAN;
 }
 
 RunningAverage::~RunningAverage()
@@ -48,7 +47,9 @@ void RunningAverage::clear()
  _cnt = 0;
  _idx = 0;
  _sum = 0.0;
- for (uint8_t i = 0; i< _size; i++)
+ _min = NAN;
+ _max = NAN;
+ for (uint8_t i = 0; i < _size; i++)
  {
  _ar[i] = 0.0; // keeps addValue simple
  }
@@ -57,15 +58,17 @@ void RunningAverage::clear()
 // adds a new value to the data-set
 void RunningAverage::addValue(double value)
 {
- if (_ar == NULL) return;
+ if (_ar == NULL) return; // allocation error
  _sum -= _ar[_idx];
  _ar[_idx] = value;
  _sum += _ar[_idx];
  _idx++;
  if (_idx == _size) _idx = 0; // faster than %
-if (_cnt == 0) _min = _max = f;
-if (f < _min) _min = f;
-if (f > _max) _max = f;
+ // handle min max
+ if (_cnt == 0) _min = _max = value;
+ else if (value < _min) _min = value;
+ else if (value > _max) _max = value;
+ // update count as last otherwise if( _cnt == 0) above will fail
  if (_cnt < _size) _cnt++;
 }
 
@@ -76,21 +79,7 @@ double RunningAverage::getAverage()
  return _sum / _cnt;
 }
 
-// returns the lowest value added to the data-set
-double RunningAverage::getMin()
-{
- if (_cnt == 0) return NAN;
- return _min;
-}
-
-// returns the highest value added to the data-set
-double RunningAverage::getMax())
-{
- if (_cnt == 0) return NAN;
- return _max;
-}
-
-// returns the value of an element if exist, 0 otherwise
+// returns the value of an element if exist, NAN otherwise
 double RunningAverage::getElement(uint8_t idx)
 {
  if (idx >=_cnt ) return NAN;

libraries/RunningAverage/RunningAverage.h

@@ -1,23 +1,23 @@
 //
 // FILE: RunningAverage.h
 // AUTHOR: Rob dot Tillaart at gmail dot com
-// VERSION: 0.2.07
-// DATE: 2015-mar-16
+// VERSION: 0.2.08
+// DATE: 2015-apr-10
 // PURPOSE: RunningAverage library for Arduino
 // URL: http://arduino.cc/playground/Main/RunningAverage
 // HISTORY: See RunningAverage.cpp
 //
 // Released to the public domain
 //
 // backwards compatibility
-// clr() clear()
-// add(x) addValue(x)
-// avg() getAverage()
+// clr()  clear()
+// add(x)  addValue(x)
+// avg()  getAverage()
 
 #ifndef RunningAverage_h
 #define RunningAverage_h
 
-#define RUNNINGAVERAGE_LIB_VERSION "0.2.07"
+#define RUNNINGAVERAGE_LIB_VERSION "0.2.08"
 
 #include "Arduino.h"
 
@@ -33,8 +33,10 @@ class RunningAverage
  void fillValue(double, uint8_t);
 
  double getAverage();
-double getMin();
-double getMax();
+ // returns lowest value added to the data-set since last clear
+ double getMin() { return _min; };
+ // returns highest value added to the data-set since last clear
+ double getMax() { return _max; };
 
  double getElement(uint8_t idx);
  uint8_t getSize() { return _size; }
@@ -44,10 +46,10 @@ class RunningAverage
  uint8_t _size;
  uint8_t _cnt;
  uint8_t _idx;
- double  _sum;
+ double _sum;
  double * _ar;
-double _min;
-double _max;
+ double _min;
+ double _max;
 };
 
 #endif

libraries/RunningAverage/examples/ra_MinMaxTest/ra_MinMaxTest.ino

@@ -0,0 +1,46 @@
+//
+// FILE: runningAverageMinMaxTest.ino
+// AUTHOR: Rob Tillaart
+// VERSION: 0.1.00
+// DATE: 2015-apr-10
+//
+// PUPROSE: demo
+//
+
+#include "RunningAverage.h"
+
+RunningAverage myRA(10);
+int samples = 0;
+
+void setup(void)
+{
+ Serial.begin(115200);
+ Serial.println("\nDemo runningAverageMinMaxTest");
+ Serial.print("Version: ");
+ Serial.println(RUNNINGAVERAGE_LIB_VERSION);
+ myRA.clear(); // explicitly start clean
+
+ Serial.println("\nCNT\tMIN\tAVG\tMAX");
+}
+
+void loop(void)
+{
+ long rn = random(0, 1000);
+ myRA.addValue(rn * 0.001);
+ samples++;
+ Serial.print(samples);
+ Serial.print("\t");
+ Serial.print(myRA.getMin(), 3);
+ Serial.print("\t");
+ Serial.print(myRA.getAverage(), 3);
+ Serial.print("\t");
+ Serial.println(myRA.getMax(), 3);
+
+ if (samples == 100)
+ {
+ samples = 0;
+ myRA.clear();
+ Serial.println("\nCNT\tMIN\tAVG\tMAX");
+ }
+ delay(10);
+}

libraries/RunningAverage/keywords.txt

@@ -15,6 +15,8 @@ RunningAverage	KEYWORD1
 clear	KEYWORD2
 addValue	KEYWORD2
 getAverage	KEYWORD2
+getMin KEYWORD2
+getMax KEYWORD2
 fillValue	KEYWORD2
 getElement	KEYWORD2
 getSize	KEYWORD2