Struct rv::dist::Uniform

pub struct Uniform { /* fields omitted */ }

Continuous uniform distribution, U(a, b) on the interval x in [a, b]

Example

The Uniform CDF is a line

use rv::prelude::*;

let u = Uniform::new(2.0, 4.0).unwrap();

// A line representing the CDF
let y = |x: f64| { 0.5 * x - 1.0 };

assert!((u.cdf(&3.0_f64) - y(3.0)).abs() < 1E-12);
assert!((u.cdf(&3.2_f64) - y(3.2)).abs() < 1E-12);

Implementations

impl Uniform

pub fn new(a: f64, b: f64) -> Result<Self, UniformError>

Create a new uniform distribution on [a, b]

pub fn new_unchecked(a: f64, b: f64) -> Self

Creates a new Uniform without checking whether the parameters are valid.

pub fn a(&self) -> f64

Get the lower bound, a

Example

let u = Uniform::new(0.0, 1.0).unwrap();
assert_eq!(u.a(), 0.0);

pub fn b(&self) -> f64

Get the upper bound, b

Example

let u = Uniform::new(0.0, 1.0).unwrap();
assert_eq!(u.b(), 1.0);

Trait Implementations

impl Cdf<f32> for Uniform

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

The value of the Cumulative Density Function at x

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

Survival function, 1 - CDF(x)

impl Cdf<f64> for Uniform

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

The value of the Cumulative Density Function at x

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

Survival function, 1 - CDF(x)

impl Clone for Uniform

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContinuousDistr<f32> for Uniform

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

The value of the Probability Density Function (PDF) at x

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

The value of the log Probability Density Function (PDF) at x

impl ContinuousDistr<f64> for Uniform

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

The value of the Probability Density Function (PDF) at x

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

The value of the log Probability Density Function (PDF) at x

impl Debug for Uniform

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

Formats the value using the given formatter.

impl Default for Uniform

fn default() -> Self

Returns the “default value” for a type.

impl Display for Uniform

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

Formats the value using the given formatter.

impl Entropy for Uniform

fn entropy(&self) -> f64

The entropy, H(X)

impl InverseCdf<f32> for Uniform

fn invcdf(&self, p: f64) -> f32

The value of the x at the given probability in the CDF

fn quantile(&self, p: f64) -> X

Alias for invcdf

fn interval(&self, p: f64) -> (X, X)

Interval containing p proportion for the probability

impl InverseCdf<f64> for Uniform

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

The value of the x at the given probability in the CDF

fn quantile(&self, p: f64) -> X

Alias for invcdf

fn interval(&self, p: f64) -> (X, X)

Interval containing p proportion for the probability

impl Kurtosis for Uniform

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

impl Mean<f32> for Uniform

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

Returns None if the mean is undefined

impl Mean<f64> for Uniform

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

Returns None if the mean is undefined

impl Median<f32> for Uniform

fn median(&self) -> Option<f32>

Returns None if the median is undefined

impl Median<f64> for Uniform

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

Returns None if the median is undefined

impl PartialEq<Uniform> for Uniform

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

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

#[must_use]

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

This method tests for !=.

impl Rv<f32> for Uniform

fn ln_f(&self, x: &f32) -> f64

Probability function

fn draw<R: Rng>(&self, rng: &mut R) -> f32

Single draw from the Rv

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<f32>

Multiple draws of the Rv

fn f(&self, x: &X) -> f64

Probability function

fn sample_stream<'r, R: Rng>(
    &'r self,
    rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples

impl Rv<f64> for Uniform

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

Probability function

fn draw<R: Rng>(&self, rng: &mut R) -> f64

Single draw from the Rv

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<f64>

Multiple draws of the Rv

fn f(&self, x: &X) -> f64

Probability function

fn sample_stream<'r, R: Rng>(
    &'r self,
    rng: &'r mut R
) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples

impl Skewness for Uniform

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

impl Support<f32> for Uniform

fn supports(&self, x: &f32) -> bool

Returns true if x is in the support of the Rv

impl Support<f64> for Uniform

fn supports(&self, x: &f64) -> bool

Returns true if x is in the support of the Rv

impl Variance<f32> for Uniform

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

Returns None if the variance is undefined

impl Variance<f64> for Uniform

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

Returns None if the variance is undefined