Struct rand::distributions::Binomial

pub struct Binomial { /* fields omitted */ }

The binomial distribution Binomial(n, p).

This distribution has density function: f(k) = n!/(k! (n-k)!) p^k (1-p)^(n-k) for k >= 0.

Example

use rand::distributions::{Binomial, Distribution};

let bin = Binomial::new(20, 0.3);
let v = bin.sample(&mut rand::thread_rng());
println!("{} is from a binomial distribution", v);

Implementations

impl Binomial

pub fn new(n: u64, p: f64) -> Binomial

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

Panics if p < 0 or p > 1.

Trait Implementations

impl Clone for Binomial

fn clone(&self) -> Binomial

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Binomial

impl Debug for Binomial

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

Formats the value using the given formatter.

impl Distribution<u64> for Binomial

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

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

fn sample_iter<'a, R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T>ⓘ

Important traits for DistIter<'a, D, R, T>

impl<'a, D, R, T> Iterator for DistIter<'a, D, R, T> where
    D: Distribution<T>,
    R: Rng + 'a,  type Item = T;

where
    Self: Sized,
    R: Rng, 

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