Struct math::histogram::Histogram

pub struct Histogram<T> where
    T: PartialOrd + NumAssign + NumOps + FromPrimitive + ToPrimitive + Copy + Display,  { /* fields omitted */ }

The Histogram consists of num_intervals intervals between the min and the max value.

Implementations

impl<T> Histogram<T> where
    T: PartialOrd + NumAssign + NumOps + FromPrimitive + ToPrimitive + Copy + Display, 

pub fn new<'a>(
    elements: Option<&'a Vec<T>>,
    num_intervals: usize,
    min: T,
    max: T
) -> Result<Histogram<T>, String> where
    &'a T: Deref, 

Initializing with Known Boundaries

Creates a Histogram consisting of num_intervals intervals between the values min and max, and inserts the values from the vector of elements into the histogram. Values smaller than min will increment the counter num_less_than_min, while values larger than max will increment the counter num_larger_than_max

Example

use math::histogram::Histogram;

let histogram =
    Histogram::new(Some(&vec![2, -1, 3, 5, 8]), 5, 0, 10).unwrap();
assert_eq!(histogram.get_boundaries().len(), 6);
assert_eq!(histogram.get_num_less_than_min(), 1);
assert_eq!(histogram.get_num_larger_than_max(), 0);
assert_eq!(histogram.get_min_received(), Some(-1));
assert_eq!(histogram.get_max_received(), Some(8));

pub fn num_intervals(&self) -> usize

pub fn get_ratios(&self) -> Vec<f64>

pub fn new_with_auto_range<'a>(
    elements: &'a Vec<T>,
    num_intervals: usize
) -> Result<Histogram<T>, String> where
    &'a T: Deref,
    T: Ord, 

pub fn get_boundaries(&self) -> &Vec<T>

pub fn get_counters(&self) -> &Vec<usize>

pub fn get_num_less_than_min(&self) -> usize

pub fn get_num_larger_than_max(&self) -> usize

pub fn get_min_received(&self) -> Option<T>

pub fn get_max_received(&self) -> Option<T>

pub fn min_boundary(&self) -> T

pub fn max_boundary(&self) -> T

Trait Implementations

impl<T> Collecting<T> for Histogram<T> where
    T: PartialOrd + NumAssign + NumOps + FromPrimitive + ToPrimitive + Copy + Display, 

pub fn collect(&mut self, item: T)

impl<T> Display for Histogram<T> where
    T: PartialOrd + NumAssign + NumOps + FromPrimitive + ToPrimitive + Copy + Display, 

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

Formats the value using the given formatter.

impl<'a, T> ToIterator<'a, HistogramIter<'a, T>, (T, T, usize)> for Histogram<T> where
    T: PartialOrd + NumAssign + NumOps + FromPrimitive + ToPrimitive + Copy + Display, 

pub fn to_iter(&'a self) -> HistogramIter<'a, T>