0.3.1 BoolArray

Author: RobTillaart

libraries/BoolArray/.github/workflows/arduino-lint.yml

@@ -6,8 +6,8 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
-      - uses: arduino/arduino-lint-action@v1
+      - uses: actions/checkout@v5
+      - uses: arduino/arduino-lint-action@v2
         with:
           library-manager: update
           compliance: strict

libraries/BoolArray/.github/workflows/arduino_test_runner.yml

@@ -8,7 +8,7 @@ jobs:
     timeout-minutes: 20
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

libraries/BoolArray/.github/workflows/jsoncheck.yml

@@ -5,13 +5,15 @@ on:
     paths:
       - '**.json'
   pull_request:
+    paths:
+      - '**.json'
 
 jobs:
   test:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
       - name: json-syntax-check
         uses: limitusus/json-syntax-check@v2
         with:

libraries/BoolArray/BoolArray.cpp

@@ -1,7 +1,7 @@
 //
 //  FILE: BoolArray.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
 //    DATE: 2015-12-06
 // PURPOSE: BoolArray library for Arduino
 //     URL: https://github.com/RobTillaart/BoolArray
@@ -19,6 +19,7 @@ BoolArray::BoolArray()
 {
   _array = NULL;
   _size = 0;
+  _bytes = 0;
 }
 
 
@@ -35,12 +36,12 @@ uint8_t BoolArray::begin(const uint16_t size)
   {
     return BOOLARRAY_SIZE_ERROR;
   }
-  // do we need to re-allocate?
+  //  do we need to re-allocate?
   if (_size != size)
   {
     _size  = size;
     _bytes = (_size + 7) / 8;
-    if (_array) 
+    if (_array)
     {
       free(_array);
     }
@@ -73,7 +74,7 @@ uint8_t BoolArray::setAll(const uint8_t value)
   if (_array == NULL) return BOOLARRAY_INIT_ERROR;
   uint8_t *p = _array;
   uint8_t t = _bytes;
-  if (value == 0) 
+  if (value == 0)
   {
     while(t--) *p++ = 0;
   }
@@ -133,6 +134,7 @@ BoolArray32::BoolArray32()
 {
   _array = NULL;
   _size = 0;
+  _bytes = 0;
 }
 
 

libraries/BoolArray/BoolArray.h

@@ -2,7 +2,7 @@
 //
 //    FILE: BoolArray.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.3.0
+// VERSION: 0.3.1
 //    DATE: 2015-12-06
 // PURPOSE: BoolArray library for Arduino
 //     URL: https://github.com/RobTillaart/BoolArray.git
@@ -15,10 +15,10 @@
 #include "Arduino.h"
 
 
-#define BOOLARRAY_LIB_VERSION     (F("0.3.0"))
+#define BOOLARRAY_LIB_VERSION     (F("0.3.1"))
 
 #ifndef BOOLARRAY_MAXSIZE
-#define BOOLARRAY_MAXSIZE         (1250 * 8)       // 8000
+#define BOOLARRAY_MAXSIZE         (1250 * 8)       //  10000
 #endif
 
 #define BOOLARRAY_OK              0x00

libraries/BoolArray/CHANGELOG.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## [0.3.1] - 2025-11-25
+- update GitHub actions
+- update readme.md (performance ESP32)
+- update examples
+- minor edits
+
 ## [0.3.0] - 2024-04-10
 - made BOOLARRAY_MAXSIZE a -D command line define option
 - increased default BOOLARRAY_MAXSIZE to 1250 x 8 = 10000 booleans

libraries/BoolArray/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2015-2024 Rob Tillaart
+Copyright (c) 2015-2025 Rob Tillaart
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

libraries/BoolArray/README.md

@@ -11,31 +11,31 @@
 
 # BoolArray
 
-Arduino library for compact array of booleans of max size 2000 (UNO).
+Arduino library for compact array of booleans of max size 10000 (UNO R3).
 
 
 ## Description
 
 The BoolArray class allows the user to instantiate an array of booleans, allocating only one bit per element. 
 For example one could create an array of 1000 throws with a coin. Normally this would take 1000 bytes,
-but BoolArray can store one throw in 1 bit, so 1000 throws in approx 125 bytes.
+but BoolArray can store one throw in 1 bit, so store the 1000 throws in approx 125 bytes.
 
 The class is optimized for storage by packing 8 elements of the array in one byte.
 You need to check if your application needs more performance than this library can deliver. 
 
-#### Notes
+### Notes
 
 The BoolArray class allocates dynamic memory.
 The **BOOLARRAY_MAXSIZE** is set to 10000 (booleans). 
-This number is chosen as it is about the maximum one can allocate in one call on an UNO. 
+This number is chosen as it is about the maximum one can allocate in one call on an UNO R3. 
 
 If one want to allocate more booleans, adjust the **BOOLARRAY_MAXSIZE**. 
 This can be done as a command line option.
 
 The library is tested on AVR architecture only.
 
 
-#### BoolArray32
+### BoolArray32
 
 Since 0.3.0 a **BoolArray32** class is added - **experimental** for now.
 
@@ -49,7 +49,7 @@ that are native 32 bit (not verified yet).
 On an Arduino UNO the **BoolArray32** class is slower.(verified).
 
 
-#### Related
+### Related
 
 The BitArray library is one from a set of three:
 
@@ -62,29 +62,31 @@ BoolArray is faster than BitArray as it only supports single bits and does not n
 of different bytes to read/write a value. However BoolArray currently only supports 2000 bits while
 BitArray can support more.
 
+
 ## Performance
 
-See **boolArrayDemo0.ino**
+Run **boolArrayDemo0.ino** to get your boards figures.
 
 Indicative performance figures.
 
 |  class        |  function   |  UNO    |  ESP32   |  Notes   |
 |:--------------|:-----------:|:-------:|:--------:|:--------:|
-|  BoolArray    |  set(0)     |  10.37  |          |  
-|  BoolArray    |  set(1)     |  10.25  |          |
-|  BoolArray    |  get(i)     |  16.03  |          |
-|  BoolArray    |  setAll(0)  |    96   |          |  per 2000
-|  BoolArray    |  setAll(1)  |   100   |          |  per 2000
+|  BoolArray    |  set(0)     |  10.37  |   0.58   |  
+|  BoolArray    |  set(1)     |  10.25  |   0.56   |
+|  BoolArray    |  get(i)     |  16.03  |   0.61   |
+|  BoolArray    |  setAll(0)  |    96   |   17     |  per 2000
+|  BoolArray    |  setAll(1)  |   100   |   10     |  per 2000
 |               |             |         |          |
-|  BoolArray32  |  set(0)     |  15.97  |          |
-|  BoolArray32  |  set(1)     |  15.84  |          |
-|  BoolArray32  |  get(i)     |  24.20  |          |
-|  BoolArray32  |  setAll(0)  |   148   |          |  per 2000
-|  BoolArray32  |  setAll(1)  |   144   |          |  per 2000
-
-- UNO 16 MHz, ESP32 240 MHz.
+|  BoolArray32  |  set(0)     |  15.97  |   0.56   |
+|  BoolArray32  |  set(1)     |  15.84  |   0.54   |
+|  BoolArray32  |  get(i)     |  24.20  |   0.59   |
+|  BoolArray32  |  setAll(0)  |   148   |   12     |  per 2000
+|  BoolArray32  |  setAll(1)  |   144   |    8     |  per 2000
+
+- UNO 16 MHz    (version 0.3.0)
+- ESP32 240 MHz (version 0.3.1)
 - toggle() is expected to be similar to set()
-- clear() is a wrapper around setAll(0) so similar.
+- clear() is a wrapper around setAll(0) so identical.
 
 
 ## Interface
@@ -93,19 +95,21 @@ Indicative performance figures.
 #include "BoolArray.h"
 ```
 
-#### Constructor
+BoolArray32 is similar, uses uint32_t where BoolArray uses uint16_t.
+
+### Constructor
 
 - **BoolArray()** Constructor
 - **~BoolArray()** Destructor
-- **uint8_t begin(uint32_t size)** dynamically allocates size elements (8 booleans in one byte). 
+- **uint8_t begin(uint16_t size)** dynamically allocates size elements (8 booleans in one byte). 
 Returns **BOOLARRAY_OK** on success.
 
-#### Meta
+### Meta
 
 - **uint16_t size()** returns number of boolean elements.
 - **uint16_t memory()** returns number of bytes used.
 
-#### Base
+### Base
 
 The following functions return **BOOLARRAY_OK** on success.
 
@@ -117,30 +121,38 @@ So one need to check these carefully.
 - **uint8_t toggle(uint16_t index)** Toggles element at index. 
 
 
+## Error codes
+
+|  code                  |  value   |  meaning  |
+|:----------------------:|:--------:|:----------|
+|  BOOLARRAY_OK          |   0x00   |
+|  BOOLARRAY_ERROR       |   0xFF   |
+|  BOOLARRAY_SIZE_ERROR  |   0xFE   |  index out of range
+|  BOOLARRAY_INIT_ERROR  |   0xFD   |  allocation error  |
+
+
 ## Future
 
 #### Must
 
 - improve documentation
-  - add performance figures (UNO + ESP32)
 
 #### Should
 
-- performance test on ESP32
-- performance for **clear()** dedicated loop vs **setAll(0)** call
 - investigate template class 
-  - improve allocation (see PrintCharArray)
 
 #### Could
 
-- update examples.
+- add examples.
 - investigate **uint32_t array[N]** for BoolArray32 (ESP32?)
   - adjust math 
 
 #### Wont
 
 - performance intern 16 bit instead of 8 bit is NOT faster on UNO
-
+- strip tests in the functions for performance.
+- performance for **clear()** dedicated loop vs **setAll(0)** call
+  - not faster.
 
 ## Support
 

libraries/BoolArray/examples/boolArrayDemo0/boolArrayDemo0.ino

@@ -8,7 +8,7 @@
 #include "BoolArray.h"
 
 
-BoolArray b;
+BoolArray32 b;
 
 uint32_t start;
 uint32_t stop;
@@ -20,9 +20,11 @@ uint32_t duration1, duration2;
 void setup()
 {
   Serial.begin(115200);
+  Serial.println();
   Serial.println(__FILE__);
   Serial.print("BOOLARRAY_LIB_VERSION:\t");
   Serial.println(BOOLARRAY_LIB_VERSION);
+  Serial.println();
 
   int rv = b.begin(2000);
   Serial.print("SIZE bits:\t");
@@ -55,7 +57,7 @@ void loop()
 void test0()
 {
   Serial.println();
-  Serial.println("TEST SET(1)");
+  Serial.println("TEST SET(true)");
   delay(10);
 
   start = micros();
@@ -87,7 +89,7 @@ void test0()
 void test1()
 {
   Serial.println();
-  Serial.println("TEST SET(0)");
+  Serial.println("TEST SET(false)");
   delay(10);
 
   start = micros();
@@ -159,14 +161,14 @@ void test3()
     b.set(i, 0);
   }
   duration1 = micros() - start;
-  Serial.print("TEST SET(0):\t");
+  Serial.print("TEST SET(false):\t");
   Serial.println(duration1);
   delay(10);
 
   start = micros();
   b.setAll(0);
   duration2 = micros() - start;
-  Serial.print("TEST SETALL(0):\t");
+  Serial.print("TEST SETALL(false):\t");
   Serial.println(duration2);
   Serial.print("FACTOR:\t\t");
   Serial.println(1.0 * duration1 / duration2);
@@ -179,14 +181,14 @@ void test3()
     b.set(i, 1);
   }
   duration1 = micros() - start;
-  Serial.print("TEST SET(1):\t");
+  Serial.print("TEST SET(true):\t");
   Serial.println(duration1);
   delay(10);
 
   start = micros();
   b.setAll(1);
   duration2 = micros() - start;
-  Serial.print("TEST SETALL(1):\t");
+  Serial.print("TEST SETALL(true):\t");
   Serial.println(duration2);
   Serial.print("FACTOR:\t\t");
   Serial.println(1.0 * duration1 / duration2);