Trait sampling::histogram::Histogram

source · 
pub trait Histogram {
    // Required methods
    fn count_multiple_index(
        &mut self,
        index: usize,
        count: usize
    ) -> Result<(), HistErrors>;
    fn hist(&self) -> &Vec<usize>;
    fn reset(&mut self);

    // Provided methods
    fn count_index(&mut self, index: usize) -> Result<(), HistErrors> { ... }
    fn bin_count(&self) -> usize { ... }
    fn any_bin_zero(&self) -> bool { ... }
}
Expand description

Implements histogram

  • anything that implements Histogram should also implement the trait HistogramVal

Required Methods§

source

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

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

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

the created histogram
source

fn reset(&mut self)

reset the histogram to zero

Provided Methods§

source

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

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

fn bin_count(&self) -> usize

How many bins the histogram contains
source

fn any_bin_zero(&self) -> bool

check if any bin was not hit yet

Implementors§