Struct ndarray_rand::rand_distr::Geometric

pub struct Geometric { /* fields omitted */ }

The geometric distribution Geometric(p) bounded to [0, u64::MAX].

This is the probability distribution of the number of failures before the first success in a series of Bernoulli trials. It has the density function f(k) = (1 - p)^k p for k >= 0, where p is the probability of success on each trial.

This is the discrete analogue of the exponential distribution.

Note that StandardGeometric is an optimised implementation for p = 0.5.

Example

use rand_distr::{Geometric, Distribution};

let geo = Geometric::new(0.25).unwrap();
let v = geo.sample(&mut rand::thread_rng());
println!("{} is from a Geometric(0.25) distribution", v);

Implementations

impl Geometric

pub fn new(p: f64) -> Result<Geometric, Error>

Construct a new Geometric with the given shape parameter p (probablity of success on each trial).

Trait Implementations

impl Clone for Geometric

pub fn clone(&self) -> Geometric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Geometric

impl Debug for Geometric

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

Formats the value using the given formatter.

impl Distribution<u64> for Geometric

pub 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.

pub 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.