Struct rv::dist::Geometric

pub struct Geometric { /* fields omitted */ }

Geometric distribution over x in {0, 1, 2, 3, ... }.

Example

use rv::prelude::*;

// Create Geometric(p=0.5)
let geom = Geometric::new(0.5).unwrap();

// Draw Samples
let mut rng = rand::thread_rng();
let xs: Vec<u32> = geom.sample(100, &mut rng);
assert_eq!(xs.len(), 100)

Methods

impl Geometric

pub fn set_p(&mut self, val: f64) -> &mut Self

impl Geometric

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

Create a new geometric distribution

pub fn new_unchecked(p: f64) -> Self

Creates a new Geometric without checking whether the parameter is valid.

pub fn p(&self) -> f64

Get the p parameter

Trait Implementations

impl<X> Cdf<X> for Geometric where
    X: Unsigned + Integer + FromPrimitive + ToPrimitive + Saturating + Bounded, 

fn cdf(&self, k: &X) -> f64

The value of the Cumulative Density Function at x

fn sf(&self, x: &X) -> f64

Survival function, 1 - CDF(x)

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 Default for Geometric

fn default() -> Self

Returns the "default value" for a type.

impl<X> DiscreteDistr<X> for Geometric where
    X: Unsigned + Integer + FromPrimitive + ToPrimitive + Saturating + Bounded, 

fn pmf(&self, x: &X) -> f64

Probability mass function (PMF) at x

fn ln_pmf(&self, x: &X) -> f64

Natural logarithm of the probability mass function (PMF)

impl Display for Geometric

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

Formats the value using the given formatter.

impl Entropy for Geometric

fn entropy(&self) -> f64

The entropy, H(X)

impl<'_> From<&'_ Geometric> for String

fn from(geom: &Geometric) -> String

Performs the conversion.

impl Kurtosis for Geometric

fn kurtosis(&self) -> Option<f64>

impl Mean<f64> for Geometric

fn mean(&self) -> Option<f64>

Returns None if the mean is undefined

impl PartialEq<Geometric> for Geometric

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Geometric> for Geometric

fn partial_cmp(&self, other: &Geometric) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<X> Rv<X> for Geometric where
    X: Unsigned + Integer + FromPrimitive + ToPrimitive + Saturating + Bounded, 

fn ln_f(&self, k: &X) -> f64

Probability function

fn draw<R: Rng>(&self, rng: &mut R) -> X

Single draw from the Rv

fn f(&self, x: &X) -> f64

Probability function

fn sample<R: Rng>(&self, n: usize, rng: &mut R) -> Vec<X>

Multiple draws of the Rv

impl Skewness for Geometric

fn skewness(&self) -> Option<f64>

impl StructuralPartialEq for Geometric

impl<X> Support<X> for Geometric where
    X: Unsigned + Integer, 

fn supports(&self, k: &X) -> bool

Returns true if x is in the support of the Rv

impl Variance<f64> for Geometric

fn variance(&self) -> Option<f64>

Returns None if the variance is undefined