Trait sampling::histogram::HistogramVal

pub trait HistogramVal<T> {
    // Required methods
    fn get_bin_index<V: Borrow<T>>(&self, val: V) -> Result<usize, HistErrors>;
    fn count_val<V: Borrow<T>>(&mut self, val: V) -> Result<usize, HistErrors>;
    fn bin_enum_iter(&self) -> Box<dyn Iterator<Item = Bin<T>> + '_>;
    fn is_inside<V: Borrow<T>>(&self, val: V) -> bool;
    fn not_inside<V: Borrow<T>>(&self, val: V) -> bool;
    fn first_border(&self) -> T;
    fn last_border(&self) -> T;
    fn last_border_is_inclusive(&self) -> bool;
    fn distance<V: Borrow<T>>(&self, val: V) -> f64;
}

• trait used for mapping values of arbitrary type T to bins
• used to create a histogram

Required Methods

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

convert val to the respective histogram index

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 bin_enum_iter(&self) -> Box<dyn Iterator<Item = Bin<T>> + '_>

binning borders

• the borders used to bin the values

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

does a value correspond to a valid bin?

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

opposite of is_inside

fn first_border(&self) -> T

get the left most border (inclusive)

fn last_border(&self) -> T

get last border from the right

• Note: this border might be inclusive or exclusive
• check last_border_is_inclusive for finding it out

fn last_border_is_inclusive(&self) -> bool

True if last border is inclusive, false otherwise

• For most usecases this will return a constant value, as this is likely only dependent on the underlying type and not on something that changes dynamically

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

calculates some sort of absolute distance to the nearest valid bin

• any invalid numbers (like NAN or INFINITY) should have the highest distance possible
• if a value corresponds to a valid bin, the distance should be zero

Object Safety

This trait is not object safe.

Implementors

impl<T> HistogramVal<T> for HistogramFast<T>

where T: PrimInt + HasUnsignedVersion + WrappingAdd, T::Unsigned: Bounded + HasUnsignedVersion<LeBytes = T::LeBytes> + WrappingAdd + ToPrimitive + Sub<Output = T::Unsigned>,

impl<T> HistogramVal<T> for HistogramFloat<T>

where T: Float + Zero + NumCast + PartialOrd + FromPrimitive,

impl<T> HistogramVal<T> for HistogramInt<T>

where T: Ord + Sub<T, Output = T> + Add<T, Output = T> + One + NumCast + Copy,

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

where B: Binning<T>,