Trait sampling::histogram::HistogramVal

pub trait HistogramVal<T> {
    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 borders_clone(&self) -> Result<Vec<T>, HistErrors>;
    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 second_last_border(&self) -> T;
    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 borders_clone(&self) -> Result<Vec<T>, HistErrors>

binning borders

• the borders used to bin the values
• any val which fullfills self.border[i] <= val < self.border[i + 1] will get index i.
• Note that the last border is exclusive

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 second_last_border(&self) -> T

• get second last border from the right
• should be the same as let b = self.borders_clone().expect("overflow"); assert_eq!(self.second_last_border(), b[b.len()-2])

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

Implementors

impl<T> HistogramVal<T> for HistogramFast<T>where
    T: PrimInt + HasUnsignedVersion,
    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,

impl<T> HistogramVal<T> for HistogramInt<T>where
    T: Ord + Sub<T, Output = T> + Add<T, Output = T> + One + NumCast + Copy,