Struct average::Histogram10

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. Read more

impl Clone for Histogram

fn clone(&self) -> Histogram

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Histogram

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

Formats the value using the given formatter. Read more

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. Read more

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. Read more

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. Read more

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. Read more

impl Merge for Histogram

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

Merge the other estimator into this one. Read more

impl MulAssign<u64> for Histogram

fn mul_assign(&mut self, other: u64)

Performs the *= operation. Read more

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. Read more

Auto Trait Implementations§

impl UnwindSafe for Histogram

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<S, T> Cast<T> for Swhere T: Conv<S>,

fn cast(self) -> T

Cast from Self to T Read more

fn try_cast(self) -> Result<T, Error>

Try converting from Self to T Read more

impl<S, T> CastApprox<T> for Swhere T: ConvApprox<S>,

fn try_cast_approx(self) -> Result<T, Error>

Try approximate conversion from Self to T Read more

fn cast_approx(self) -> T

Cast approximately from Self to T Read more

impl<S, T> CastFloat<T> for Swhere T: ConvFloat<S>,

fn cast_trunc(self) -> T

Cast to integer, truncating Read more

fn cast_nearest(self) -> T

Cast to the nearest integer Read more

fn cast_floor(self) -> T

Cast the floor to an integer Read more

fn cast_ceil(self) -> T

Cast the ceiling to an integer Read more

fn try_cast_trunc(self) -> Result<T, Error>

Try converting to integer with truncation Read more

fn try_cast_nearest(self) -> Result<T, Error>

Try converting to the nearest integer Read more

fn try_cast_floor(self) -> Result<T, Error>

Try converting the floor to an integer Read more

fn try_cast_ceil(self) -> Result<T, Error>

Try convert the ceiling to an integer Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for Twhere U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.