Struct ndarray_rand::rand_distr::Poisson

pub struct Poisson<N> { /* fields omitted */ }

The Poisson distribution Poisson(lambda).

This distribution has a density function: f(k) = lambda^k * exp(-lambda) / k! for k >= 0.

Example

use rand_distr::{Poisson, Distribution};

let poi = Poisson::new(2.0).unwrap();
let v: u64 = poi.sample(&mut rand::thread_rng());
println!("{} is from a Poisson(2) distribution", v);

Methods

impl<N> Poisson<N> where
    N: Float,
    Standard: Distribution<N>, 

pub fn new(lambda: N) -> Result<Poisson<N>, Error>

Construct a new Poisson with the given shape parameter lambda.

Trait Implementations

impl<N> Distribution<N> for Poisson<N> where
    N: Float,
    Standard: Distribution<N>, 

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

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

Important traits for DistIter<D, R, T>

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

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

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

impl<N> Distribution<u64> for Poisson<N> where
    N: Float,
    Standard: Distribution<N>, 

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

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

Important traits for DistIter<D, R, T>

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

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

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

impl<N> Copy for Poisson<N> where
    N: Copy, 

impl<N> Clone for Poisson<N> where
    N: Clone, 

fn clone(&self) -> Poisson<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Poisson<N> where
    N: Debug, 

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

Formats the value using the given formatter.