# [−][src]Struct statrs::distribution::DiscreteUniform

`pub struct DiscreteUniform { /* fields omitted */ }`

Implements the Discrete Uniform distribution

# Examples

```use statrs::distribution::{DiscreteUniform, Discrete};
use statrs::statistics::Mean;

let n = DiscreteUniform::new(0, 5).unwrap();
assert_eq!(n.mean(), 2.5);
assert_eq!(n.pmf(3), 1.0 / 6.0);```

## Methods

### `impl DiscreteUniform`[src]

#### `pub fn new(min: i64, max: i64) -> Result<DiscreteUniform>`[src]

Constructs a new discrete uniform distribution with a minimum value of `min` and a maximum value of `max`.

# Errors

Returns an error if `max < min`

# Examples

```use statrs::distribution::DiscreteUniform;

let mut result = DiscreteUniform::new(0, 5);
assert!(result.is_ok());

result = DiscreteUniform::new(5, 0);
assert!(result.is_err());```

## Trait Implementations

### `impl Univariate<i64, f64> for DiscreteUniform`[src]

#### `fn cdf(&self, x: f64) -> f64`[src]

Calculates the cumulative distribution function for the discrete uniform distribution at `x`

# Formula

`(floor(x) - min + 1) / (max - min + 1)`

### `impl Discrete<i64, f64> for DiscreteUniform`[src]

#### `fn pmf(&self, x: i64) -> f64`[src]

Calculates the probability mass function for the discrete uniform distribution at `x`

# Remarks

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

# Formula

`1 / (max - min + 1)`

#### `fn ln_pmf(&self, x: i64) -> f64`[src]

Calculates the log probability mass function for the discrete uniform distribution at `x`

# Remarks

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

# Formula

`ln(1 / (max - min + 1))`

### `impl Min<i64> for DiscreteUniform`[src]

#### `fn min(&self) -> i64`[src]

Returns the minimum value in the domain of the discrete uniform distribution

# Remarks

This is the same value as the minimum passed into the constructor

### `impl Max<i64> for DiscreteUniform`[src]

#### `fn max(&self) -> i64`[src]

Returns the maximum value in the domain of the discrete uniform distribution

# Remarks

This is the same value as the maximum passed into the constructor

### `impl Mean<f64> for DiscreteUniform`[src]

#### `fn mean(&self) -> f64`[src]

Returns the mean of the discrete uniform distribution

# Formula

`(min + max) / 2`

### `impl Variance<f64> for DiscreteUniform`[src]

#### `fn variance(&self) -> f64`[src]

Returns the variance of the discrete uniform distribution

# Formula

`((max - min + 1)^2 - 1) / 12`

#### `fn std_dev(&self) -> f64`[src]

Returns the standard deviation of the discrete uniform distribution

# Formula

`sqrt(((max - min + 1)^2 - 1) / 12)`

### `impl Entropy<f64> for DiscreteUniform`[src]

#### `fn entropy(&self) -> f64`[src]

Returns the entropy of the discrete uniform distribution

# Formula

`ln(max - min + 1)`

### `impl Skewness<f64> for DiscreteUniform`[src]

#### `fn skewness(&self) -> f64`[src]

Returns the skewness of the discrete uniform distribution

# Formula

`0`

### `impl Median<f64> for DiscreteUniform`[src]

#### `fn median(&self) -> f64`[src]

Returns the median of the discrete uniform distribution

# Formula

`(max + min) / 2`

### `impl Mode<i64> for DiscreteUniform`[src]

#### `fn mode(&self) -> i64`[src]

Returns the mode for the discrete 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`

### `impl Clone for DiscreteUniform`[src]

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl Distribution<f64> for DiscreteUniform`[src]

#### `fn sample_iter<R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where    R: Rng, `[src]

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

## Blanket Implementations

### `impl<T> ToOwned for T where    T: Clone, `[src]

#### `type Owned = T`

The resulting type after obtaining ownership.

### `impl<T, U> TryFrom<U> for T where    U: Into<T>, `[src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

### `impl<T, U> TryInto<U> for T where    U: TryFrom<T>, `[src]

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

The type returned in the event of a conversion error.