mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-10-03 18:09:02 -04:00
88 lines
2.4 KiB
Markdown
88 lines
2.4 KiB
Markdown
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
|
[](https://github.com/RobTillaart/SET/actions/workflows/arduino-lint.yml)
|
|
[](https://github.com/RobTillaart/SET/actions/workflows/jsoncheck.yml)
|
|
[](https://github.com/RobTillaart/SET/blob/master/LICENSE)
|
|
[](https://github.com/RobTillaart/SET/releases)
|
|
|
|
|
|
# SET
|
|
|
|
Arduino library to implement a simple SET data structure.
|
|
|
|
|
|
## Description
|
|
|
|
The set library implements the set data structure for integers 0..255.
|
|
This limit is chosen because of the memory limitations of an Arduino UNO,
|
|
however these numbers can be used as indices to a table of strings or other
|
|
data types.
|
|
|
|
|
|
## Interface
|
|
|
|
|
|
### Constructor
|
|
|
|
- **Set(bool clear = true)** creates an empty set, default it is cleared.
|
|
- **Set(&Set)** copies a set.
|
|
|
|
|
|
### Set level
|
|
|
|
- **clear()** empty the set.
|
|
- **invert()** flip all elements in the set.
|
|
- **addAll()** add all 256 elements to the set.
|
|
- **count()** returns the number of elements.
|
|
- **isEmpty()** idem
|
|
- **isFull()** idem
|
|
|
|
|
|
### Element level
|
|
|
|
- **add(uint8_t value)** add element n to the Set.
|
|
- **sub(uint8_t value)** remove element n from the Set.
|
|
- **invert(uint8_t value)** flip element n in the Set.
|
|
- **has(uint8_t value)** check if element n is in the Set.
|
|
|
|
|
|
### Operators
|
|
|
|
- union + +=
|
|
- diff - -=
|
|
- intersection * *=
|
|
|
|
|
|
### Equality
|
|
|
|
- equal ==
|
|
- not equal !=
|
|
- is subSet <=
|
|
|
|
A superSet B is not implemented as one could say B subSet A (B <= A)
|
|
|
|
|
|
### Iterators
|
|
|
|
all iterator-functions returns the current element or -1 if not exist.
|
|
|
|
- **setCurrent(n)** if n is in the Set, n will be the current
|
|
- **first()** find the first element
|
|
- **next()** find the next element. Will not wrap around when 'end' of the set is reached.
|
|
- **prev()** find the previous element. Will not wrap around when 'begin' of the set is reached.
|
|
- **last()** find the last element.
|
|
- **getNth(n)** find the Nth element in a set if it exist.
|
|
|
|
|
|
## Operational
|
|
|
|
See examples
|
|
|
|
|
|
## Future
|
|
|
|
- update documentation
|
|
- separate releaseNotes.md
|
|
|
|
|