Struct average::Histogram10

pub struct Histogram10 { /* fields omitted */ }

A histogram with a number of bins known at compile time.

Implementations

impl Histogram

pub fn with_const_width(start: f64, end: f64) -> Self

Construct a histogram with constant bin width.

pub fn from_ranges<T>(ranges: T) -> Result<Self, InvalidRangeError> where
    T: IntoIterator<Item = f64>, 

Construct a histogram from given ranges.

The ranges are given by an iterator of floats where neighboring pairs (a, b) define a bin for all x where a <= x < b.

Fails if the iterator is too short (less than n + 1 where n is the number of bins), is not sorted or contains nan. inf and empty ranges are allowed.

pub fn find(&self, x: f64) -> Result<usize, SampleOutOfRangeError>

Find the index of the bin corresponding to the given sample.

Fails if the sample is out of range of the histogram.

pub fn add(&mut self, x: f64) -> Result<(), SampleOutOfRangeError>

Add a sample to the histogram.

Fails if the sample is out of range of the histogram.

pub fn ranges(&self) -> &[f64]

Return the ranges of the histogram.

pub fn iter(&self) -> IterHistogram<'_>

Return an iterator over the bins and corresponding ranges: ((lower, upper), count)

pub fn reset(&mut self)

Reset all bins to zero.

pub fn range_min(&self) -> f64

Return the lower range limit.

(The corresponding bin might be empty.)

pub fn range_max(&self) -> f64

Return the upper range limit.

(The corresponding bin might be empty.)

Trait Implementations

impl<'a> AddAssign<&'a Histogram> for Histogram

fn add_assign(&mut self, other: &Self)

Performs the += operation.

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, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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 Histogram for Histogram

fn bins(&self) -> &[u64]

Return the bins of the histogram.

fn variance(&self, bin: usize) -> f64

Estimate the variance for the given bin.

fn normalized_bins(&self) -> IterNormalized<<&Self as IntoIterator>::IntoIter>

Return an iterator over the bins normalized by the bin widths.

fn widths(&self) -> IterWidths<<&Self as IntoIterator>::IntoIter>

Return an iterator over the bin widths.

fn centers(&self) -> IterBinCenters<<&Self as IntoIterator>::IntoIter>

Return an iterator over the bin centers.

fn variances(&self) -> IterVariances<<&Self as IntoIterator>::IntoIter>

Return an iterator over the bin variances.

impl<'a> IntoIterator for &'a Histogram

type Item = ((f64, f64), u64)

The type of the elements being iterated over.

type IntoIter = IterHistogram<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IterHistogram<'a>

Creates an iterator from a value.

impl Merge for Histogram

fn merge(&mut self, other: &Self)

Merge the other estimator into this one.

impl MulAssign<u64> for Histogram

fn mul_assign(&mut self, other: u64)

Performs the *= operation.

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.