Struct rv::dist::Geometric

pub struct Geometric { /* private fields */ }

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)

Implementations

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

pub fn set_p(&mut self, p: f64) -> Result<(), GeometricError>

Set the p parameter

Example

let mut geom = Geometric::new(0.2).unwrap();
geom.set_p(0.5).unwrap();

assert_eq!(geom.p(), 0.5);

Will error for invalid values

assert!(geom.set_p(0.5).is_ok());
assert!(geom.set_p(1.0).is_ok());
assert!(geom.set_p(0.0).is_err());
assert!(geom.set_p(-1.0).is_err());
assert!(geom.set_p(1.1).is_err());
assert!(geom.set_p(std::f64::INFINITY).is_err());
assert!(geom.set_p(std::f64::NEG_INFINITY).is_err());
assert!(geom.set_p(std::f64::NAN).is_err());

pub fn set_p_unchecked(&mut self, p: f64)

Set p without input validation

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<'de> Deserialize<'de> for Geometric

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

Converts to this type from the input type.

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

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

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

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

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

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

fn sample_stream<'r, R: Rng>( &'r self, rng: &'r mut R ) -> Box<dyn Iterator<Item = X> + 'r>

Create a never-ending iterator of samples

impl Serialize for Geometric

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Skewness for Geometric

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

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