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
sourceimpl Uniform
impl Uniform
sourcepub fn new(min: f64, max: f64) -> Result<Uniform>
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
sourceimpl ContinuousCDF<f64, f64> for Uniform
impl ContinuousCDF<f64, f64> for Uniform
sourcefn cdf(&self, x: f64) -> f64
fn cdf(&self, x: f64) -> f64
Calculates the cumulative distribution function for the uniform
distribution
at x
Formula
(x - min) / (max - min)sourcefn inverse_cdf(&self, p: T) -> K
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
sourceimpl Distribution<f64> for Uniform
impl Distribution<f64> for Uniform
sourcefn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
Generate a random value of T, using rng as the source of randomness.
sourcefn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,
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
sourceimpl Distribution<f64> for Uniform
impl Distribution<f64> for Uniform
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
sourcepub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self from the equivalent element of its
superset. Read more
sourcepub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self is actually part of its subset T (and can be converted to it).
sourcepub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
sourcepub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self to the equivalent element of its superset.
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more