Struct rand_distr::Poisson

pub struct Poisson<F>where
    F: Float + FloatConst,
    Standard: Distribution<F>,{ /* private fields */ }

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 = poi.sample(&mut rand::thread_rng());
println!("{} is from a Poisson(2) distribution", v);

Implementations

impl<F> Poisson<F>where
    F: Float + FloatConst,
    Standard: Distribution<F>,

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

Construct a new Poisson with the given shape parameter lambda.

Trait Implementations

impl<F: Clone> Clone for Poisson<F>where
    F: Float + FloatConst,
    Standard: Distribution<F>,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for Poisson<F>where
    F: Float + FloatConst,
    Standard: Distribution<F>,

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

Formats the value using the given formatter.

impl<F> Distribution<F> for Poisson<F>where
    F: Float + FloatConst,
    Standard: Distribution<F>,

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

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

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.

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

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<F: Copy> Copy for Poisson<F>where
    F: Float + FloatConst,
    Standard: Distribution<F>,