Struct sampling::histogram::GenericHist

pub struct GenericHist<B, T> { /* private fields */ }

Provides Histogram functionallity

• Is automatically implemented for any type that implements Binning

Implementations

impl<B, T> GenericHist<B, T>

where B: Binning<T>,

pub fn new(binning: B) -> Self

Create a new histogram from an arbitrary binning

pub fn binning(&self) -> &B

Get reference to underlying binning

Trait Implementations

impl<B, T> Histogram for GenericHist<B, T>

where B: Binning<T>,

fn hist(&self) -> &Vec<usize>

the created histogram

fn any_bin_zero(&self) -> bool

check if any bin was not hit yet

fn bin_count(&self) -> usize

How many bins the histogram contains

fn count_index(&mut self, index: usize) -> Result<(), HistErrors>

self.hist[index] += 1, Err() if index out of bounds

fn count_multiple_index( &mut self, index: usize, count: usize ) -> Result<(), HistErrors>

self.hist[index] += count, Err() if index out of bounds

fn reset(&mut self)

reset the histogram to zero

impl<T, B> HistogramVal<T> for GenericHist<B, T>

where B: Binning<T>,

fn get_bin_index<V: Borrow<T>>(&self, val: V) -> Result<usize, HistErrors>

convert val to the respective histogram index

fn first_border(&self) -> T

get the left most border (inclusive)

fn is_inside<V: Borrow<T>>(&self, val: V) -> bool

does a value correspond to a valid bin?

fn count_val<V: Borrow<T>>(&mut self, val: V) -> Result<usize, HistErrors>

count val. Ok(index), if inside of hist, Err(_) if val is invalid

fn not_inside<V: Borrow<T>>(&self, val: V) -> bool

opposite of is_inside

fn last_border(&self) -> T

get last border from the right

fn last_border_is_inclusive(&self) -> bool

True if last border is inclusive, false otherwise

fn distance<V: Borrow<T>>(&self, val: V) -> f64

calculates some sort of absolute distance to the nearest valid bin

fn bin_enum_iter(&self) -> Box<dyn Iterator<Item = Bin<T>>>

binning borders