Struct statrs::distribution::Uniform

source · [−]

pub struct Uniform { /* private fields */ }

Expand description

Implements the Continuous Uniform distribution

Examples

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

let n = Uniform::new(0.0, 1.0).unwrap();
assert_eq!(n.mean().unwrap(), 0.5);
assert_eq!(n.pdf(0.5), 1.0);

Implementations

source

impl Uniform

source

pub fn new(min: f64, max: f64) -> Result<Uniform>

Constructs a new uniform distribution with a min of min and a max of max

Errors

Returns an error if min or max are NaN

Examples

use statrs::distribution::Uniform;
use std::f64;

let mut result = Uniform::new(0.0, 1.0);
assert!(result.is_ok());

result = Uniform::new(f64::NAN, f64::NAN);
assert!(result.is_err());

Trait Implementations

source

impl Clone for Uniform

source

fn clone(&self) -> Uniform

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

source

impl Continuous<f64, f64> for Uniform

source

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

Calculates the probability density function for the continuous uniform distribution at x

Remarks

Returns 0.0 if x is not in [min, max]

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

Calculates the log probability density function for the continuous uniform distribution at x

Remarks

Returns f64::NEG_INFINITY if x is not in [min, max]

impl ContinuousCDF<f64, f64> for Uniform

source

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

Calculates the cumulative distribution function for the uniform distribution at x

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

Calculates the survival function for the uniform distribution at x

fn inverse_cdf(&self, p: T) -> K

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

source

impl Debug for Uniform

source

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

Formats the value using the given formatter. Read more

source

impl Distribution<f64> for Uniform

source

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

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

source

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

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

source

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

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

source

impl Distribution<f64> for Uniform

source

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

Returns the mean for the continuous uniform distribution

Formula

(min + max) / 2

source

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

Returns the variance for the continuous uniform distribution

Formula

(max - min)^2 / 12

source

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

Returns the entropy for the continuous uniform distribution

Formula

ln(max - min)

source

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

Returns the skewness for the continuous uniform distribution

Formula

source

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

Returns the standard deviation, if it exists. Read more

source

impl Max<f64> for Uniform

source

fn max(&self) -> f64

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

source

impl Median<f64> for Uniform

source

fn median(&self) -> f64

Returns the median for the continuous uniform distribution

Formula

(min + max) / 2

source

impl Min<f64> for Uniform

source

fn min(&self) -> f64

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

source

impl Mode<Option<f64>> for Uniform

source

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

Returns the mode for the continuous uniform distribution

Remarks

Since every element has an equal probability, mode simply returns the middle element

Formula

N/A // (max + min) / 2 for the middle element

source

impl PartialEq<Uniform> for Uniform

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

source

impl Copy for Uniform

source

impl StructuralPartialEq for Uniform

Auto Trait Implementations

impl RefUnwindSafe for Uniform

impl Send for Uniform

impl Sync for Uniform

impl Unpin for Uniform

impl UnwindSafe for Uniform

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

impl<T> Same<T> 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.

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

fn vzip(self) -> V

source

Struct statrs::distribution::Uniform

Implementations

impl Uniform

pub fn new(min: f64, max: f64) -> Result<Uniform>

Trait Implementations

impl Clone for Uniform

fn clone(&self) -> Uniform

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

impl Continuous<f64, f64> for Uniform

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

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

impl ContinuousCDF<f64, f64> for Uniform

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

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

fn inverse_cdf(&self, p: T) -> K

impl Debug for Uniform

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

impl Distribution<f64> for Uniform

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

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

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

impl Distribution<f64> for Uniform

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

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

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

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

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

impl Max<f64> for Uniform

fn max(&self) -> f64

impl Median<f64> for Uniform

fn median(&self) -> f64

impl Min<f64> for Uniform

fn min(&self) -> f64

impl Mode<Option<f64>> for Uniform

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

impl PartialEq<Uniform> for Uniform

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

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

impl Copy for Uniform

impl StructuralPartialEq for Uniform

Auto Trait Implementations

impl RefUnwindSafe for Uniform

impl Send for Uniform

impl Sync for Uniform

impl Unpin for Uniform

impl UnwindSafe for Uniform

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

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

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

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

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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<T> + Debug,

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

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

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

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

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

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

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

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

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

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

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

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