Macro ndhistogram::sparsehistogram

macro_rules! sparsehistogram {
    ($( $x:expr ),+ $(,)*; $type:ty $(;)*) => { ... };
    ($( $x:expr ),+ $(,)*) => { ... };
}

Creates a sparse Histogram.

As ndhistogram, but creates a sparse histogram of type HashHistogram. The arguments are a command separated list of Axis. Optionally, the type of the Histogram bin values may specified after a semi-colon after the list of Axis. If the bin value type is not specified, the default is f64.

Example

Creating a sparse 1D Histogram

use ndhistogram::axis::Uniform;
use std::fmt::Display;
use ndhistogram::{sparsehistogram, Histogram};

let hist1D = sparsehistogram!(Uniform::new(10, -5.0, 5.0));
println!("{}", hist1D);

Creating a sparse 2D Histogram

use ndhistogram::axis::{Uniform, Axis};
use ndhistogram::{sparsehistogram, Histogram};

let hist2D = sparsehistogram!(Uniform::new(10, -5.0, 5.0), Uniform::new(10, -5.0, 5.0));
// each axis has 10+2 bins due to under/overflow
assert_eq!(hist2D.axes().num_bins(), 12*12)

Creating a Histogram with a specific bin value type

use ndhistogram::axis::Uniform;
use ndhistogram::{sparsehistogram, Histogram};
use ndhistogram::value::Mean;

let mut hist = sparsehistogram!(Uniform::new(10, -5.0, 5.0); Mean);
hist.fill_with(&0.0, 1.0);
hist.fill_with(&0.0, 3.0);
assert_eq!(hist.value(&0.0).unwrap().get(), 2.0) // mean of [1.0, 3.0] is 2.0