Struct rv::dist::DiscreteUniform

pub struct DiscreteUniform<T: DuParam> { /* fields omitted */ }

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

Methods

impl<T: DuParam> DiscreteUniform<T>

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

Create a new discreet uniform distribution

Arguments

• a: lower bound
• b : upper bound

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

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

pub fn a(&self) -> T

Get lower bound parameter, a

Example

let du = DiscreteUniform::new(1_u8, 22_u8).unwrap();
assert_eq!(du.a(), 1);

pub fn b(&self) -> T

Get upper bound parameter, a

Example

let du = DiscreteUniform::new(1_u8, 22_u8).unwrap();
assert_eq!(du.b(), 22);

Trait Implementations

impl<X, T> Rv<X> for DiscreteUniform<T> where
    T: DuParam + SampleUniform + Copy,
    X: Integer + From<T>, 

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

Probability function

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

Single draw from the Rv

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

Multiple draws of the Rv

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

Probability function

impl<X, T> Support<X> for DiscreteUniform<T> where
    X: Integer + From<T>,
    T: DuParam, 

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

Returns true if x is in the support of the Rv

impl<X, T> Cdf<X> for DiscreteUniform<T> where
    X: Integer + From<T> + ToPrimitive + Copy,
    T: DuParam + SampleUniform + ToPrimitive, 

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

The value of the Cumulative Density Function at x

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

Survival function, 1 - CDF(x)

impl<X, T> InverseCdf<X> for DiscreteUniform<T> where
    X: Integer + From<T> + FromPrimitive,
    T: DuParam + SampleUniform + ToPrimitive, 

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

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<X, T> DiscreteDistr<X> for DiscreteUniform<T> where
    X: Integer + From<T>,
    T: DuParam + SampleUniform + Into<f64>, 

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

Probability mass function (PMF) at x

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

Natural logarithm of the probability mass function (PMF)

impl<T> Mean<f64> for DiscreteUniform<T> where
    T: DuParam + SampleUniform + Into<f64>, 

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

Returns None if the mean is undefined

impl<T> Median<f64> for DiscreteUniform<T> where
    T: DuParam + SampleUniform + Into<f64>, 

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

Returns None if the median is undefined

impl<T> Variance<f64> for DiscreteUniform<T> where
    T: DuParam + SampleUniform + Into<f64>, 

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

Returns None if the variance is undefined

impl<T> Entropy for DiscreteUniform<T> where
    T: DuParam + Into<f64>, 

fn entropy(&self) -> f64

The entropy, H(X)

impl<T: DuParam> Skewness for DiscreteUniform<T>

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

impl<T: DuParam> Kurtosis for DiscreteUniform<T>

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

impl<'_, T> From<&'_ DiscreteUniform<T>> for String where
    T: DuParam + Display, 

fn from(u: &DiscreteUniform<T>) -> String

Performs the conversion.

impl<T: Clone + DuParam> Clone for DiscreteUniform<T>

fn clone(&self) -> DiscreteUniform<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Eq + DuParam> Eq for DiscreteUniform<T>

impl<T: Ord + DuParam> Ord for DiscreteUniform<T>

fn cmp(&self, other: &DiscreteUniform<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<T: PartialEq + DuParam> PartialEq<DiscreteUniform<T>> for DiscreteUniform<T>

fn eq(&self, other: &DiscreteUniform<T>) -> bool

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

fn ne(&self, other: &DiscreteUniform<T>) -> bool

This method tests for !=.

impl<T: PartialOrd + DuParam> PartialOrd<DiscreteUniform<T>> for DiscreteUniform<T>

fn partial_cmp(&self, other: &DiscreteUniform<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &DiscreteUniform<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &DiscreteUniform<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &DiscreteUniform<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &DiscreteUniform<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Display for DiscreteUniform<T> where
    T: DuParam + Display, 

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

Formats the value using the given formatter.

impl<T: Debug + DuParam> Debug for DiscreteUniform<T>

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

Formats the value using the given formatter.

impl<T: Hash + DuParam> Hash for DiscreteUniform<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].