fix

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
 ## [0.3.6] - 2024-01-03
+- add **float saturation()**
 - fix examples
 - minor edits
 

README.md

@@ -102,7 +102,7 @@ Length should be less than 65534.
 - **~Histogram16()** destructor.
 
 
-#### maxBucket
+#### MaxBucket
 
 Default the maxBucket size is defined as 255 (8 bit), 65535 (16 bit) or
 2147483647 (32 bit) depending on class used.
@@ -190,6 +190,18 @@ Note **PDF()** is a continuous function and therefore not applicable in a discre
 - https://en.wikipedia.org/wiki/Probability_density_function  PDF()
 
 
+#### Experimental
+
+An additional helper function.
+
+- **float saturation()** returns the **count()** / nr of bins.
+Is an indicator of how "filled" the histogram is.
+
+Might need to calculate the average level.
+
+Note: **findMax()** gives an indication for the topmost individual bucket.
+
+
 ## Future
 
 

histogram.cpp

@@ -329,6 +329,18 @@ uint16_t Histogram::countBelow(const int32_t level)
 }
 
 
+
+///////////////////////////////////////////////////
+//
+//  experimental
+//
+//  use with care
+float Histogram::saturation()
+{
+  return (1.0 * _count) / _length;
+}
+
+
 //  experimental use with care
 int32_t Histogram::getMaxBucket()
 {

histogram.h

@@ -60,6 +60,12 @@ class Histogram
   uint16_t countBelow(const int32_t level);
 
 
+  ///////////////////////////////////////////////////
+  //
+  //  experimental
+  //
+  float    saturation();
+
   //  use with care
   int32_t  getMaxBucket();
   void     setMaxBucket(int32_t value);