[−][src]Crate ndhistogram

Multi-dimensional histogramming for Rust.

Features include:

  • Histograms with any number of dimensions from 1 up to 21 dimensions.
  • Continuous (eg represented by a floating point number) and discrete axis (eg a category represented by a string value or enum) types.
  • Flexible bin values including any primitive number type, or a user-defined struct.
  • Unweighted and weighted filling of histograms.
  • Flexible, user-definable axis types.

Quick-start

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

// create a 1D histogram with 10 equally sized bins between -5 and 5
let mut hist = ndhistogram!(Uniform::new(10, -5.0, 5.0));
// fill this histogram with a single value
hist.fill(&1.0);
// fill this histogram with weights
hist.fill_with(&2.0, 4.0);
// read the histogram values
let x1 = hist.value(&1.0);
let also_x1 = hist.value_at_index(7);
assert_eq!(x1, also_x1);
// iterate the histogram values
for item in hist.iter() {
    println!("{}, {}, {}", item.index, item.bin, item.value)
}
// print the histogram to stdout
println!("{}", hist);


// create a 2D histogram
let mut hist = ndhistogram!(Uniform::new(10, -5.0, 5.0), Uniform::new(10, -5.0, 5.0));
// fill 2D histogram
hist.fill(&(1.0, 2.0));
// read back the histogram values
let x1_y2 = hist.value(&(1.0, 2.0));

// Several axis types are available
let mut hist = ndhistogram!(Category::new(vec!["Red", "Blue", "Green"]));
hist.fill(&"Red");
let red_value = hist.value(&"Red");
// and user axis types may be created by implementing the Axis trait

// The Histogram bin value type is configurable
let mut hist = ndhistogram!(Uniform::new(10, -5.0, 5.0); i32);
hist.fill_with(&1.0, 2);
let value: Option<&i32> = hist.value(&1.0);
// and user defined value types are possible by implementing Fill and FillWith traits

Overview

A Histogram is composed of two components:

  • An Axis for 1D histograms or set of Axes for higher dimensional histograms. The Axes and Axis map from coodinate space (eg [x,y,z]) to an integer bin number.
  • The histogram bin value storage. Bin values may be any type that implements Fill, FillWith or [FillWithWeight] (including any integer and floating number type).

Histogram Implementations

  • VecHistogram: bin values are stored in a Vec. Created with the ndhistogram macro. This is the recommended implementation for most use cases. However, as memory is allocated even for empty bins, this may not be practical for very high dimension histograms.

Alternative implentations are possible by implementing the Histogram trait.

Axis Implementations

User defined axes types are possible by implementing the Axis trait.

Histogram Bin Values

Histograms may be filled with values of the following types.

This crate defines the following bin value types:

  • Sum : a simple bin count that counts the number of times it has been filled.
  • WeightedSum : as Sum but with weighted fills.
  • Mean : computes the mean of the values it is filled with.
  • WeightedMean : as Mean but with weighted fills.

User defined bin value types are possible by implementing the Fill, FillWith or FillWithWeighted traits.

Modules

axis

Axis for ND histograms

value

Bin Value types for ND-histograms

Macros

ndhistogram

Creates a Histogram.

Structs

Item

Struct to be returned when iterating over Histograms bins.

VecHistogram

A Histogram that stores its values in a Vec.

Traits

Axes

Axes provided an interface for a set of ND dimensional set of histograms.

Fill

Fill a histogram bin value with unit weight.

FillWith

Fill a histogram bin value with some data.

FillWithWeighted

Fill a histogram with some weighted value.

Histogram

A common interface for an ND histograms.