GY-63_MS5611/libraries/BoolArray
2020-11-27 11:10:47 +01:00
..
examples update libraries A-D 2020-11-27 11:10:47 +01:00
BoolArray.cpp update libraries A-D 2020-11-27 11:10:47 +01:00
BoolArray.h update libraries A-D 2020-11-27 11:10:47 +01:00
library.json update libraries A-D 2020-11-27 11:10:47 +01:00
library.properties update libraries A-D 2020-11-27 11:10:47 +01:00
LICENSE update libraries A-D 2020-11-27 11:10:47 +01:00
README.md update libraries A-D 2020-11-27 11:10:47 +01:00

BoolArray

Arduino library for compact array of booleans of max size 2000 (UNO).

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.

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.

The BoolArray library is one from a set of three:

  • BitArray for elements of user defined size in bits (values 0 .. 2^n-1)
  • BoolArray for elements of 1 bit (values 0 .. 1)
  • nybbleArray for elements of 4 bits (values 0 .. 15)

BoolArray is faster than BitArray as it only supports single bits and does not need to merge parts of different bytes to read/write a value. However BoolArray currently only supports 2000 bits while BitArray can support more.

Operations

In the function begin(#elements) the number of elements needs to be defined.

The basic functions of the class are

  • set(index, value)
  • get(index)
  • toggle(index)
  • clear()

Check out the examples.

Notes

The BoolArray class dynamicly allocates memory. The BOOLARRAY_MAXSIZE is set to 2000, this was chosen as malloc() can only allocate 255 bytes in one call on an UNO. This is not checked with the recent versions of the IDE anymore.

The library is tested on AVR architecture only.