rewrite of the histogram crate

clocksource/src/precise/duration.rs

@@ -34,6 +34,13 @@ impl Duration {
         }
     }
 
+    /// Create a new `Duration` from a whole number of milliseconds.
+    pub const fn from_millis(millis: u32) -> Self {
+        Self {
+            ns: millis as u64 * Self::MILLISECOND.as_nanos()
+        }
+    }
+
     /// Create a new `Duration` from a whole number of milliseconds.
     ///
     /// *Note*: this will return an error on overflow.
@@ -47,10 +54,17 @@ impl Duration {
         }
     }
 
+    /// Create a new `Duration` from a whole number of microseconds.
+    pub const fn from_micros(micros: u32) -> Self {
+        Self {
+            ns: micros as u64 * Self::MICROSECOND.as_nanos()
+        }
+    }
+
     /// Create a new `Duration` from a whole number of microseconds.
     ///
     /// *Note*: this will return an error on overflow.
-    pub const fn from_micros(micros: u64) -> Result<Self, TryFromError> {
+    pub const fn try_from_micros(micros: u64) -> Result<Self, TryFromError> {
         if let Some(ns) = micros.checked_mul(Self::MICROSECOND.as_nanos()) {
             Ok(Self { ns })
         } else {

heatmap/Cargo.toml

@@ -10,7 +10,7 @@ repository = "https://github.com/pelikan-io/rustcommon"
 
 [dependencies]
 clocksource = { version = "0.6.0" }
-histogram = { version = "0.7.4", path = "../histogram" }
+histogram = { version = "0.7.4" }
 parking_lot = "0.12.1"
 thiserror = "1.0.34"
 

histogram/Cargo.toml

@@ -1,25 +1,24 @@
 [package]
 name = "histogram"
-version = "0.7.4"
+version = "0.8.0"
 edition = "2021"
 authors = ["Brian Martin <brian@pelikan.io>"]
-license = "Apache-2.0"
-description = "Fast and simple atomic histograms"
-homepage = "https://github.com/pelikan-io/rustcommon/histogram"
+license = "MIT OR Apache-2.0"
+description = "A collection of histogram datastructures"
+homepage = "https://github.com/pelikan-io/rustcommon"
 repository = "https://github.com/pelikan-io/rustcommon"
 
 [dependencies]
+clocksource = { version = "0.7.0", path = "../clocksource" }
 serde = { version = "1.0.144", features = ["derive"], optional = true }
-thiserror = "1.0.38"
-
-[dev-dependencies]
-criterion = "0.4.0"
-itertools = "0.11.0"
+thiserror = "1.0.47"
 
 [features]
-default = ["serde-serialize"]
-serde-serialize = ["serde"]
+serde = ["dep:serde"]
 
 [[bench]]
-name = "bench"
+name = "histogram"
 harness = false
+
+[dev-dependencies]
+criterion = "0.3"

histogram/benches/histogram.rs

@@ -0,0 +1,102 @@
+use core::time::Duration;
+use criterion::Throughput;
+use histogram::Histogram;
+use histogram::atomic::Histogram as AtomicHistogram;
+
+// use criterion::BenchmarkId;
+use criterion::Criterion;
+use criterion::{criterion_group, criterion_main};
+
+fn histogram(c: &mut Criterion) {
+    let mut histogram = Histogram::new(0,7,64).unwrap();
+
+    let mut group = c.benchmark_group("histogram");
+    group.throughput(Throughput::Elements(1));
+    group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+
+    histogram.clear();
+    group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+
+    group.finish();
+}
+
+fn histogram_atomic(c: &mut Criterion) {
+    let histogram = AtomicHistogram::new(0,7,64).unwrap();
+
+    let mut group = c.benchmark_group("histogram::atomic");
+    group.throughput(Throughput::Elements(1));
+    group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+
+    histogram.clear();
+    group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+
+    group.finish();
+}
+
+fn sliding_window(c: &mut Criterion) {
+    // microsecond resolution
+
+    let mut histogram = histogram::sliding_window::Histogram::new(0,7,64, Duration::from_micros(1), 100).unwrap();
+
+    let mut group = c.benchmark_group("histogram::sliding_window/microseconds");
+    group.throughput(Throughput::Elements(1));
+    group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+    group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+    group.finish();
+
+    // millisecond resolution
+
+    let mut histogram = histogram::sliding_window::Histogram::new(0,7,64, Duration::from_millis(1), 100).unwrap();
+
+    let mut group = c.benchmark_group("histogram::sliding_window/milliseconds");
+    group.throughput(Throughput::Elements(1));
+    group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+    group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+    group.finish();
+
+    // second resolution
+
+    let mut histogram = histogram::sliding_window::Histogram::new(0,7,64, Duration::from_secs(1), 100).unwrap();
+
+    let mut group = c.benchmark_group("histogram::sliding_window/seconds");
+    group.throughput(Throughput::Elements(1));
+    group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+    group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+    group.finish();
+}
+
+fn sliding_window_atomic(c: &mut Criterion) {
+    // // microsecond resolution
+
+    // let histogram = histogram::sliding_window::atomic::Histogram::new(0,7,64, Duration::from_micros(1), 100).unwrap();
+
+    // let mut group = c.benchmark_group("histogram::sliding_window::atomic/microseconds");
+    // group.throughput(Throughput::Elements(1));
+    // group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+    // group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+    // group.finish();
+
+    // millisecond resolution
+
+    let histogram = histogram::sliding_window::atomic::Histogram::new(0,7,64, Duration::from_millis(1), 100).unwrap();
+
+    let mut group = c.benchmark_group("histogram::sliding_window::atomic/milliseconds");
+    group.throughput(Throughput::Elements(1));
+    group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+    group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+    group.finish();
+
+    // second resolution
+
+    let histogram = histogram::sliding_window::atomic::Histogram::new(0,7,64, Duration::from_secs(1), 100).unwrap();
+
+    let mut group = c.benchmark_group("histogram::sliding_window::atomic/seconds");
+    group.throughput(Throughput::Elements(1));
+    group.bench_function("increment/1", |b| b.iter(|| histogram.increment(1)));
+    group.bench_function("increment/max", |b| b.iter(|| histogram.increment(u64::MAX)));
+    group.finish();
+}
+
+
+criterion_group!(benches, histogram, histogram_atomic, sliding_window, sliding_window_atomic);
+criterion_main!(benches);