Struct Geometric

pub struct Geometric { /* private fields */ }

The geometric distribution Geometric(p).

This is the probability distribution of the number of failures (bounded to [0, u64::MAX]) before the first success in a series of Bernoulli trials, where the probability of success on each trial is p.

This is the discrete analogue of the exponential distribution.

See StandardGeometric for an optimised implementation for p = 0.5.

Density function

f(k) = (1 - p)^k p for k >= 0.

Plot

The following plot illustrates the geometric distribution for various values of p. Note how higher p values shift the distribution to the left, and the mean of the distribution is 1/p.

Example

use rand_distr::{Geometric, Distribution};

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

Implementations

impl Geometric

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

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

Trait Implementations

impl Clone for Geometric

fn clone(&self) -> Geometric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Geometric

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

Formats the value using the given formatter.

impl Distribution<u64> for Geometric

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<R>(self, rng: R) -> Iter<Self, R, T>

where R: Rng, Self: Sized,

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

fn map<F, S>(self, func: F) -> Map<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Map sampled values to type S

impl PartialEq for Geometric

fn eq(&self, other: &Geometric) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Geometric

impl StructuralPartialEq for Geometric