Struct Histogram

pub struct Histogram { /* private fields */ }

Histogram used as the basis for statistics counting in many quality control facets. For more in depth information, please see the module-level documentation.

Implementations

impl Histogram

pub fn zero_based_with_capacity(capacity: usize) -> Self

Creates a zero-based histogram with a given capacity.

pub fn increment(&mut self, bin: usize) -> Result<(), BinOutOfBoundsError>

Increments a particular bin in the histogram by one.

pub fn increment_by( &mut self, bin: usize, value: usize, ) -> Result<(), BinOutOfBoundsError>

Increments a particular bin in the histogram by the specified value.

pub fn get(&self, bin: usize) -> usize

Gets a value for a bin within a histogram.

pub fn values(&self) -> &[usize]

Simply returns the values in the distribution by ref.

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

Normalizes the values so that they sum to one and returns them as a Vec.

pub fn range_len(&self) -> usize

Gives the length of the open range for the histogram.

pub fn range_start(&self) -> usize

Gives the starting position for the open range of the histogram.

pub fn range_stop(&self) -> usize

Gives the stopping position for the open range of the histogram.

pub fn in_range(&self, value: usize) -> bool

Indicates whether a particular value falls within the range of the histogram.

use ngs::utils::histogram::Histogram;
let mut hist = Histogram::zero_based_with_capacity(100);

assert!(hist.in_range(0));
assert!(hist.in_range(100));
assert!(!hist.in_range(101));

pub fn mean(&self) -> f64

Computes the mean of all values within the histogram.

pub fn percentile(&self, percentile: f64) -> Result<Option<f64>>

Computes the value of the nth percentile based on an exhaustive search.

pub fn first_quartile(&self) -> Option<f64>

Computes the first quartile of the distribution.

pub fn median(&self) -> Option<f64>

Computes the mean of the distribution.

pub fn third_quartile(&self) -> Option<f64>

Computes the third quartile of the distribution.

pub fn interquartile_range(&self) -> Option<f64>

Computes the interquartile range for this distribution.

pub fn sum(&self) -> usize

Computes the sum of the values within the distribution.

pub fn count_from_bottom_until(&self, bin: usize) -> usize

Counts from the bottom of the histogram up until a certain bin.

pub fn count_from_top_until(&self, bin: usize) -> usize

Counts from the top of the histogram down until a certain bin.

More accurately, we technically walk from the specified bin up to the top of the histogram, but this provides the same results.

Trait Implementations

impl Clone for Histogram

fn clone(&self) -> Histogram

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Histogram

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

Formats the value using the given formatter.

impl Default for Histogram

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Histogram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Histogram

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

where __S: Serializer,

Serialize this value into the given Serde serializer.