# Struct rand_distr::Binomial

``pub struct Binomial { /* private fields */ }``
Expand description

The binomial distribution `Binomial(n, p)`.

The binomial distribution is a discrete probability distribution which describes the probability of seeing `k` successes in `n` independent trials, each of which has success probability `p`.

## §Density function

`f(k) = n!/(k! (n-k)!) p^k (1-p)^(n-k)` for `k >= 0`.

## §Known issues

See documentation of `Binomial::new`.

## §Plot

The following plot of the binomial distribution illustrates the probability of `k` successes out of `n = 10` trials with `p = 0.2` and `p = 0.6` for `0 <= k <= n`.

## §Example

``````use rand_distr::{Binomial, Distribution};

let bin = Binomial::new(20, 0.3).unwrap();
println!("{} is from a binomial distribution", v);``````

## Implementations§

source§

### impl Binomial

source

#### pub fn new(n: u64, p: f64) -> Result<Binomial, Error>

Construct a new `Binomial` with the given shape parameters `n` (number of trials) and `p` (probability of success).

##### §Known issues

Although this method should return an `Error` on invalid parameters, some (extreme) parameter combinations are known to return a `Binomial` object which panics when sampled. See #1378.

## Trait Implementations§

source§

### impl Clone for Binomial

source§

#### fn clone(&self) -> Binomial

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

### impl Debug for Binomial

source§

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

Formats the value using the given formatter. Read more
source§

### impl<'de> Deserialize<'de> for Binomial

source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

### impl Distribution<u64> for Binomial

source§

#### fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> u64

Generate a random value of `T`, using `rng` as the source of randomness.
source§

#### fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> ⓘwhere R: Rng, Self: Sized,

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

#### fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of `Self` through the closure `F` Read more
source§

### impl PartialEq for Binomial

source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl Serialize for Binomial

source§

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

Serialize this value into the given Serde serializer. Read more
source§

source§

§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> CloneToUninit for Twhere T: Clone,

source§

#### unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dst`. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> ToOwned for Twhere T: Clone,

source§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

source§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

source§

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

The type returned in the event of a conversion error.
source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

source§

source§