Struct Geometric

pub struct Geometric { /* private fields */ }

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<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) -> DistIter<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) -> DistMap<Self, F, T, S>

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

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

impl Copy for Geometric

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes