Empirical

statrs::distribution

Struct Empirical

pub struct Empirical { /* private fields */ }

Expand description

Implements the Empirical Distribution

§Examples

use statrs::distribution::{Continuous, Empirical};
use statrs::statistics::Distribution;

let samples = vec![0.0, 5.0, 10.0];

let empirical = Empirical::from_iter(samples);
assert_eq!(empirical.mean().unwrap(), 5.0);

Implementations§

impl Empirical

pub fn new() -> Result<Empirical, Infallible>

Constructs a new discrete uniform distribution with a minimum value of min and a maximum value of max.

Note that this will always succeed and never return the Err variant.

§Examples

use statrs::distribution::Empirical;

let mut result = Empirical::new();
assert!(result.is_ok());

pub fn add(&mut self, data_point: f64)

pub fn remove(&mut self, data_point: f64)

Trait Implementations§

impl Clone for Empirical

fn clone(&self) -> Empirical

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl ContinuousCDF<f64, f64> for Empirical

fn cdf(&self, x: f64) -> f64

Returns the cumulative distribution function calculated at x for a given distribution. May panic depending on the implementor. Read more

fn sf(&self, x: f64) -> f64

Returns the survival function calculated at x for a given distribution. May panic depending on the implementor. Read more

fn inverse_cdf(&self, p: f64) -> f64

Due to issues with rounding and floating-point accuracy the default implementation may be ill-behaved. Specialized inverse cdfs should be used whenever possible. Performs a binary search on the domain of cdf to obtain an approximation of F^-1(p) := inf { x | F(x) >= p }. Needless to say, performance may may be lacking.

impl Debug for Empirical

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

Formats the value using the given formatter. Read more

impl Display for Empirical

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

Formats the value using the given formatter. Read more

impl Distribution<f64> for Empirical

Available on crate feature rand only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>
where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness. Read more

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>
where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F Read more

impl Distribution<f64> for Empirical

fn mean(&self) -> Option<f64>

Returns the mean, if it exists. Read more

fn variance(&self) -> Option<f64>

Returns the variance, if it exists. Read more

fn std_dev(&self) -> Option<T>

Returns the standard deviation, if it exists. Read more

fn entropy(&self) -> Option<T>

Returns the entropy, if it exists. Read more

fn skewness(&self) -> Option<T>

Returns the skewness, if it exists. Read more

impl FromIterator<f64> for Empirical

fn from_iter<T: IntoIterator<Item = f64>>(iter: T) -> Self

Creates a value from an iterator. Read more

impl Max<f64> for Empirical

Panics if number of samples is zero

fn max(&self) -> f64

Returns the maximum value in the domain of a given distribution if it exists, otherwise None. Read more

impl Min<f64> for Empirical

Panics if number of samples is zero

fn min(&self) -> f64

Returns the minimum value in the domain of a given distribution if it exists, otherwise None. Read more

impl PartialEq for Empirical

fn eq(&self, other: &Empirical) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Empirical

Auto Trait Implementations§

impl Freeze for Empirical

impl RefUnwindSafe for Empirical

impl Send for Empirical

impl Sync for Empirical

impl Unpin for Empirical

impl UnwindSafe for Empirical

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where 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> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where 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> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where 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<U>>::Error>

Performs the conversion.

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

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,