Struct compute::distributions::Poisson

pub struct Poisson { /* fields omitted */ }

Implements the Poisson distribution.

Implementations

impl Poisson

pub fn new(lambda: f64) -> Self

Create a new Poisson distribution with rate parameter lambda.

Errors

Panics if lambda <= 0.0.

pub fn set_lambda(&mut self, lambda: f64) -> &mut Self

Trait Implementations

impl Clone for Poisson

fn clone(&self) -> Poisson

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Poisson

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

Formats the value using the given formatter.

impl Default for Poisson

fn default() -> Self

Returns the “default value” for a type.

impl Discrete for Poisson

fn pmf(&self, k: i64) -> f64

Calculates the probability mass function for the given Poisson distribution at k.

impl Distribution for Poisson

fn sample(&self) -> f64

Samples from the given Poisson distribution. For lambda < 10.0, this is done with the direct (multiplication) method, and for lambda >= 10.0, this is done the PTRS transformed rejection method from Hoermann.

type Output = f64

impl Distribution1D for Poisson

fn update(&mut self, params: &[f64])

Update the parameters of the distribution.

fn sample_n(&self, n: usize) -> Vector

Generates a vector of n randomly sampled values from the given probability distribution.

fn sample_matrix(&self, nrows: usize, ncols: usize) -> Matrix

Generates a matrix of size n x m with values randomly sampled from the given distribution.

impl Mean for Poisson

fn mean(&self) -> f64

Calculates the mean, which is given by the rate parameter.

type MeanType = f64

impl Variance for Poisson

fn var(&self) -> f64

Calculates the variance, which is given by the rate parameter.

type VarianceType = f64

impl Copy for Poisson