2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
[](https://github.com/marketplace/actions/arduino_ci)
|
2021-12-28 10:28:44 -05:00
|
|
|
[](https://github.com/RobTillaart/Statistic/actions/workflows/arduino-lint.yml)
|
|
|
|
|
[](https://github.com/RobTillaart/Statistic/actions/workflows/arduino-lint.yml)
|
2021-01-29 06:31:58 -05:00
|
|
|
[](https://github.com/RobTillaart/Statistic/blob/master/LICENSE)
|
|
|
|
|
[](https://github.com/RobTillaart/Statistic/releases)
|
|
|
|
|
|
|
|
|
|
|
2020-11-27 05:33:55 -05:00
|
|
|
# Statistic
|
|
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
Statistic library for Arduino includes sum, average, variance and standard deviation.
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
|
|
|
|
|
## Description
|
2020-11-27 05:33:55 -05:00
|
|
|
|
|
|
|
|
The statistic library is made to get basic statistical information from a
|
|
|
|
|
one dimensional set of data, e.g. a stream of values of a sensor.
|
|
|
|
|
|
|
|
|
|
The stability of the formulas is improved by the help of Gil Ross (Thanks!)
|
|
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
## Interface
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
- **Statistic(bool useStdDev = true)** Constructor, default use the standard deviation.
|
2021-01-29 06:31:58 -05:00
|
|
|
functions. Setting this flag to **false** reduces math so slight increase of performance.
|
|
|
|
|
- **void clear(bool useStdDev = true)** resets all variables.
|
|
|
|
|
- **float add(float value)** (since 0.4.3) returns value actually added to internal sum.
|
2021-12-28 10:28:44 -05:00
|
|
|
If this is (much) different from what should be added it might become time to call **clear()**.
|
|
|
|
|
- **uint32_t count()** returns zero if count == zero (of course).
|
|
|
|
|
- **float sum()** returns zero if count == zero.
|
|
|
|
|
- **float minimum()** returns zero if count == zero.
|
|
|
|
|
- **float maximum()** returns zero if count == zero.
|
|
|
|
|
- **float average()** returns NAN if count == zero.
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
These three functions only work if **useStdDev == true**
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
- **variance()** returns NAN if count == zero.
|
|
|
|
|
- **pop_stdev()** population stdev, returns NAN if count == zero.
|
|
|
|
|
- **unbiased_stdev()** returns NAN if count == zero.
|
2020-11-27 05:33:55 -05:00
|
|
|
|
|
|
|
|
|
2021-01-29 06:31:58 -05:00
|
|
|
## Operational
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
See examples.
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
## Faq
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
See faq.md
|
2021-01-29 06:31:58 -05:00
|
|
|
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
## Future
|
2020-11-27 05:33:55 -05:00
|
|
|
|
2021-12-28 10:28:44 -05:00
|
|
|
- update documentation
|
|
|
|
|
- links that explain statistics in more depth
|
|
|
|
|
- derived classes
|
|
|
|
|
- 32 bit with fixed sign version?
|
|
|
|
|
- 64 bit with fixed sign version?
|
|
|
|
|
- double version?
|
|
|
|
|
- create releaseNotes.md
|
2020-11-27 05:33:55 -05:00
|
|
|
|
