Struct net_ensembles::sampling::HistogramInt

pub struct HistogramInt<T> { /* fields omitted */ }

Generic Histogram for integer types

Implementations

impl<T> HistogramInt<T>

pub fn borders(&self) -> &Vec<T, Global>

similar to self.borders_clone but does not allocate memory

impl<T> HistogramInt<T> where
    T: Zero + Copy + PartialOrd<T> + ToPrimitive + FromPrimitive + CheckedAdd + One<Output = T> + HasUnsignedVersion + Bounded + Sub<T, Output = T> + Mul<T>,
    RangeInclusive<T>: Iterator,
    <T as HasUnsignedVersion>::Unsigned: Bounded,
    <T as HasUnsignedVersion>::Unsigned: HasUnsignedVersion,
    <T as HasUnsignedVersion>::Unsigned: WrappingAdd,
    <T as HasUnsignedVersion>::Unsigned: ToPrimitive,
    <T as HasUnsignedVersion>::Unsigned: Sub<<T as HasUnsignedVersion>::Unsigned>,
    <T as HasUnsignedVersion>::Unsigned: Rem<<T as HasUnsignedVersion>::Unsigned>,
    <T as HasUnsignedVersion>::Unsigned: FromPrimitive,
    <T as HasUnsignedVersion>::Unsigned: Zero,
    <T as HasUnsignedVersion>::Unsigned: Eq,
    <T as HasUnsignedVersion>::Unsigned: Div<<T as HasUnsignedVersion>::Unsigned>,
    <T as HasUnsignedVersion>::Unsigned: Ord,
    <T as HasUnsignedVersion>::Unsigned: Mul<<T as HasUnsignedVersion>::Unsigned>,
    <T as HasUnsignedVersion>::Unsigned: WrappingSub,
    <T as HasUnsignedVersion>::Unsigned: Copy,
    RangeInclusive<<T as HasUnsignedVersion>::Unsigned>: Iterator,
    <RangeInclusive<T> as Iterator>::Item == T,
    <<T as HasUnsignedVersion>::Unsigned as HasUnsignedVersion>::LeBytes == <T as HasUnsignedVersion>::LeBytes,
    <<T as HasUnsignedVersion>::Unsigned as HasUnsignedVersion>::Unsigned == <T as HasUnsignedVersion>::Unsigned,
    <<T as HasUnsignedVersion>::Unsigned as Sub<<T as HasUnsignedVersion>::Unsigned>>::Output == <T as HasUnsignedVersion>::Unsigned,
    <<T as HasUnsignedVersion>::Unsigned as Rem<<T as HasUnsignedVersion>::Unsigned>>::Output == <T as HasUnsignedVersion>::Unsigned,
    <<T as HasUnsignedVersion>::Unsigned as Div<<T as HasUnsignedVersion>::Unsigned>>::Output == <T as HasUnsignedVersion>::Unsigned,
    <<T as HasUnsignedVersion>::Unsigned as Mul<<T as HasUnsignedVersion>::Unsigned>>::Output == <T as HasUnsignedVersion>::Unsigned,
    <RangeInclusive<<T as HasUnsignedVersion>::Unsigned> as Iterator>::Item == <T as HasUnsignedVersion>::Unsigned, 

pub fn new(
    left: T,
    right: T,
    bins: usize
) -> Result<HistogramInt<T>, HistErrors>

Create a new histogram

• right: exclusive border
• left: inclusive border
• bins: how many bins do you need?

Note

• (right - left) % bins == 0 has to be true, otherwise the bins cannot all have the same length!

pub fn new_inclusive(
    left: T,
    right: T,
    bins: usize
) -> Result<HistogramInt<T>, HistErrors>

Create a new histogram

• equivalent to Self::new(left, right + 1, bins) (except that this method checks for possible overflow)

Note:

• Due to implementation details, right cannot be T::MAX - if you try, you will get Err(HistErrors::Overflow)

Trait Implementations

impl<T> Clone for HistogramInt<T> where
    T: Clone, 

pub fn clone(&self) -> HistogramInt<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for HistogramInt<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for HistogramInt<T> where
    T: Deserialize<'de>, 

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<HistogramInt<T>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Histogram for HistogramInt<T>

pub fn bin_count(&self) -> usize

How many bins the histogram contains

pub fn hist(&self) -> &Vec<usize, Global>

the created histogram

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

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

pub fn reset(&mut self)

reset the histogram to zero

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

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

fn any_bin_zero(&self) -> bool

check if any bin was not hit yet

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

pub fn interval_distance_overlap<V>(
    &self,
    val: V,
    overlap: NonZeroUsize
) -> usize where
    V: Borrow<T>, 

Distance metric for how far a value is from a valid interval

impl<T> HistogramPartition for HistogramInt<T> where
    T: Clone + Debug, 

pub fn overlapping_partition(
    &self,
    n: usize,
    overlap: usize
) -> Result<Vec<HistogramInt<T>, Global>, HistErrors>

partition the interval

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

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

None if not inside Hist covered zone

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

calculates some sort of absolute distance to the nearest valid bin

pub fn first_border(&self) -> T

get the left most border (inclusive)

pub 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])

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

does a value correspond to a valid bin?

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

opposite of is_inside

pub fn borders_clone(&self) -> Result<Vec<T, Global>, HistErrors>

binning borders

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

count val. Some(index), if inside of hist, None if val is invalid

impl<T> Serialize for HistogramInt<T> where
    T: Serialize, 

pub fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.