Struct Histogram

pub struct Histogram { /* private fields */ }

A basic Histogram type.

Implementations

impl Histogram

pub const fn new(sig_figs: i32) -> Self

Create a new histogram with the specified number of sig_figs.

Panics

Under the same conditions as SigFigBucketizer::new.

pub fn sig_figs(&self) -> i32

Return the nubmer of significant figures in use for this histogram.

pub fn observe(&mut self, x: f64) -> Result<(), Error>

Observe a value x and increment the bucket for x.

This will never fail with Error::ExceedsMax because it will resize.

pub fn observe_n(&mut self, x: f64, n: u64) -> Result<(), Error>

Observe a value x and increment its bucket n times.

This will never fail with Error::ExceedsMax because it will resize.

pub fn iter(&self) -> impl Iterator<Item = (f64, u64)> + '_

Return an iterator over this bucket.

pub fn dump<W: Write>(&self, w: W) -> Result<(), Error>

Dump a histogram to the specified writer.

pub fn load<R: Read>(r: R) -> Result<Self, Error>

Load a histogram from the specified reader.

pub fn downsample(&self, sig_figs: i32) -> Self

Create a new histogram downsampled to the specified number of significant figures.

Panics

If sig_figs < 1 or sig_figs > 4 or sig_figs > self.sig_figs().

pub fn merge(one: &Self, two: &Self) -> Self

Merge two histograms without loss of precision.

Panics

If the signficant figures are different between the histograms.

Trait Implementations

impl Clone for Histogram

fn clone(&self) -> Histogram

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Histogram

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.