0.1.02 - added errorhandling + performance demo sketch

Author: RobTillaart

libraries/BoolArray/BoolArray.cpp

@@ -1,13 +1,14 @@
 //
 // FILE: BoolArray.cpp
 // AUTHOR: Rob Tillaart
-// VERSION: 0.1.01
+// VERSION: 0.1.02
 // PURPOSE: BoolArray library for Arduino
 // URL: http://forum.arduino.cc/index.php?topic=361167
 
 //
 // Released to the public domain
 //
+// 0.1.02 - added errorhandling
 // 0.1.01 - fixed constructor - Thanks WPD64 + error handling
 // 0.1.00 - initial version
 //
@@ -16,7 +17,7 @@
 
 BoolArray::BoolArray()
 {
- _ar = null;
+ _ar = NULL;
  _size = 0;
 }
 
@@ -27,37 +28,49 @@ BoolArray::~BoolArray()
 
 uint8_t BoolArray::begin(const uint16_t size)
 {
- if (size > BOOLARRAY_MAXSIZE) return 255;
+ if (size > BOOLARRAY_MAXSIZE) return BOOLARRAY_SIZE_ERROR;
  _size = size;
  if (_ar) free(_ar);
- _ar = (byte*) malloc((_size+7)/8);
- return 0;
+ _ar = (byte*) malloc((_size + 7) / 8);
+ return BOOLARRAY_OK;
 }
 
 uint8_t BoolArray::get(const uint16_t idx)
 {
- if (_ar == null) return 255;
+ if (_ar == NULL) return BOOLARRAY_INIT_ERROR;
+ if (idx >= _size) return BOOLARRAY_SIZE_ERROR;
  uint8_t by = idx / 8;
  uint8_t bi = idx & 7;
  return (_ar[by] >> bi) & 0x01;
 }
 
-void BoolArray::set(const uint16_t idx, uint8_t value)
+uint8_t BoolArray::set(const uint16_t idx, const uint8_t value)
 {
- if (_ar == null) return;
+ if (_ar == NULL) return BOOLARRAY_INIT_ERROR;
+ if (idx >= _size) return BOOLARRAY_SIZE_ERROR;
  uint8_t by = idx / 8;
  uint8_t bi = idx & 7;
  if (value == 0) _ar[by] &= ~(1 << bi);
  else _ar[by] |= (1 << bi);
+ return BOOLARRAY_OK;
 }
 
-void BoolArray::clear()
+uint8_t BoolArray::clear()
 {
- if (_ar == null) return;
- for (int i = 0; i < (_size+7)/8; i++)
+ return setAll(0);
+}
+
+uint8_t BoolArray::setAll(const uint8_t value)
+{
+ if (_ar == NULL) return BOOLARRAY_INIT_ERROR;
+ uint8_t *p = _ar;
+ uint8_t t = (_size + 7) / 8;
+ uint8_t v = value?255:0;
+ while(t--)
  {
- _ar[i] = 0;
+ *p++ = v;
  }
+ return BOOLARRAY_OK;
 }
 
 // END OF FILE

libraries/BoolArray/BoolArray.h

@@ -3,13 +3,13 @@
 //
 // FILE: BoolArray.h
 // AUTHOR: Rob dot Tillaart at gmail dot com
-// VERSION: 0.1.00
+// VERSION: 0.1.02
 // PURPOSE: BoolArray library for Arduino
 // HISTORY: See BoolArray.cpp
 //
 // Released to the public domain
 //
-// BoolArray implement a comapct array of booleans of max size 2000
+// BoolArray implement a compact array of booleans of max size 2000
 //
 
 #if defined(ARDUINO) && ARDUINO >= 100
@@ -18,8 +18,12 @@
 #include "WProgram.h"
 #endif
 
-#define BOOLARRAY_LIB_VERSION "0.1.01"
+#define BOOLARRAY_LIB_VERSION "0.1.02"
 #define BOOLARRAY_MAXSIZE (250*8)
+#define BOOLARRAY_OK 0x00
+#define BOOLARRAY_ERROR 0xFF
+#define BOOLARRAY_SIZE_ERROR 0xFE
+#define BOOLARRAY_INIT_ERROR 0xFD
 
 class BoolArray
 {
@@ -28,12 +32,13 @@ class BoolArray
  ~BoolArray();
 
  uint8_t begin(const uint16_t size);
- void clear();
+ uint8_t clear();
+ uint8_t setAll(const uint8_t value);
  uint8_t get(const uint16_t idx);
- void set(const uint16_t idx, uint8_t value);
+ uint8_t set(const uint16_t idx, const uint8_t value);
 
 private:
- byte * _ar;
+ uint8_t * _ar;
  uint16_t _size;
 };
 

libraries/BoolArray/examples/boolArrayDemo2/boolArrayDemo2.ino

@@ -0,0 +1,117 @@
+//
+// FILE: boolArrayDemo2.ino
+// AUTHOR: Rob Tillaart
+// VERSION: 0.1.00
+// PURPOSE: demo performance reading boolean array
+// DATE: 2015-12-12
+// URL: https://forum.arduino.cc/index.php?topic=361167.0
+//
+// Released to the public domain
+//
+
+#include "BoolArray.h"
+
+BoolArray b;
+
+uint32_t start;
+uint32_t stop;
+volatile long x = 0;
+
+void setup()
+{
+ Serial.begin(115200);
+ Serial.print("Start ");
+ Serial.println(__FILE__);
+ Serial.print("LIB VERSION:\t");
+ Serial.println(BOOLARRAY_LIB_VERSION);
+
+ b.begin(1000);
+
+ Serial.println("\nget"); 
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ x += b.get(i);
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ x += b.get(i);
+ x += b.get(i);
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+ Serial.print(" X:\t");
+ Serial.println(x);
+
+ Serial.println("\nset"); 
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ b.set(i, 0);
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ b.set(i, 0);
+ b.set(i, 0);
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+
+ Serial.println("\nclear"); 
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ b.clear();
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ b.clear();
+ b.clear();
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+
+ Serial.println("\nsetAll"); 
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ b.setAll(1);
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+
+ start = micros();
+ for (int i = 0; i < 1000; i++)
+ {
+ b.setAll(1);
+ b.setAll(1);
+ }
+ stop = micros();
+ Serial.print("DURATION:\t");
+ Serial.println(stop - start);
+
+ Serial.println("Done...");
+}
+
+void loop()
+{
+}