Struct rv::dist::DiscreteUniform

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

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

Implementations

impl<T: DuParam> DiscreteUniform<T>

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

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> 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<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: Debug + DuParam> Debug for DiscreteUniform<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for DiscreteUniform<T>

where T: Deserialize<'de> + DuParam,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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> Display for DiscreteUniform<T>

where T: DuParam + Display,

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

Formats the value using the given formatter.

impl<T> Entropy for DiscreteUniform<T>

where T: DuParam + Into<f64>,

fn entropy(&self) -> f64

The entropy, H(X)

impl<T> From<&DiscreteUniform<T>> for String

where T: DuParam + Display,

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

Converts to this type from the input type.

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<T: DuParam> Kurtosis for DiscreteUniform<T>

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

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: PartialEq + DuParam> PartialEq 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: &Rhs) -> bool

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

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

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<T> Serialize for DiscreteUniform<T>

where T: Serialize + DuParam,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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

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

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<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: Eq + DuParam> Eq for DiscreteUniform<T>

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