Struct statrs::distribution::Geometric

source · [−]

pub struct Geometric { /* private fields */ }

Expand description

Implements the Geometric distribution

Examples

use statrs::distribution::{Geometric, Discrete};
use statrs::statistics::Distribution;

let n = Geometric::new(0.3).unwrap();
assert_eq!(n.mean().unwrap(), 1.0 / 0.3);
assert_eq!(n.pmf(1), 0.3);
assert_eq!(n.pmf(2), 0.21);

Implementations

source

impl Geometric

source

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

Constructs a new shifted geometric distribution with a probability of p

Errors

Returns an error if p is not in (0, 1]

Examples

use statrs::distribution::Geometric;

let mut result = Geometric::new(0.5);
assert!(result.is_ok());

result = Geometric::new(0.0);
assert!(result.is_err());

source

pub fn p(&self) -> f64

Returns the probability p of the geometric distribution

Examples

use statrs::distribution::Geometric;

let n = Geometric::new(0.5).unwrap();
assert_eq!(n.p(), 0.5);

Trait Implementations

source

impl Clone for Geometric

source

fn clone(&self) -> Geometric

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Geometric

source

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

Formats the value using the given formatter. Read more

source

impl Discrete<u64, f64> for Geometric

source

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

Calculates the probability mass function for the geometric distribution at x

Formula

(1 - p)^(x - 1) * p

source

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

Calculates the log probability mass function for the geometric distribution at x

Formula

ln((1 - p)^(x - 1) * p)

source

impl DiscreteCDF<u64, f64> for Geometric

source

fn cdf(&self, x: u64) -> f64

Calculates the cumulative distribution function for the geometric distribution at x

Formula

1 - (1 - p) ^ (x + 1)

source

fn inverse_cdf(&self, p: T) -> K

Due to issues with rounding and floating-point accuracy the default implementation may be ill-behaved Specialized inverse cdfs should be used whenever possible. Read more

source

impl Distribution<f64> for Geometric

source

fn sample<R: Rng + ?Sized>(&self, r: &mut R) -> f64

Generate a random value of T, using rng as the source of randomness.

source

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. Read more

source

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where
F: Fn(T) -> S,

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

source

impl Distribution<f64> for Geometric

source

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

Returns the mean of the geometric distribution

Formula

1 / p

source

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

Returns the standard deviation of the geometric distribution

Formula

(1 - p) / p^2

source

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

Returns the entropy of the geometric distribution

Formula

(-(1 - p) * log_2(1 - p) - p * log_2(p)) / p

source

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

Returns the skewness of the geometric distribution

Formula

(2 - p) / sqrt(1 - p)

source

fn std_dev(&self) -> Option<T>

Returns the standard deviation, if it exists. Read more

source

impl Max<u64> for Geometric

source

fn max(&self) -> u64

Returns the maximum value in the domain of the geometric distribution representable by a 64-bit integer

Formula

2^63 - 1

source

impl Median<f64> for Geometric

source

fn median(&self) -> f64

Returns the median of the geometric distribution

Remarks

Formula

ceil(-1 / log_2(1 - p))

source

impl Min<u64> for Geometric

source

fn min(&self) -> u64

Returns the minimum value in the domain of the geometric distribution representable by a 64-bit integer

Formula

source

impl Mode<Option<u64>> for Geometric

source

fn mode(&self) -> Option<u64>

Returns the mode of the geometric distribution

Formula

source

impl PartialEq<Geometric> for Geometric

source

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

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

source

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

This method tests for !=.

source

impl Copy for Geometric

source

impl StructuralPartialEq for Geometric

Auto Trait Implementations

impl RefUnwindSafe for Geometric

impl Send for Geometric

impl Sync for Geometric

impl Unpin for Geometric

impl UnwindSafe for Geometric

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,

source

pub fn inlined_clone(&self) -> T

Performance hack: Clone doesn’t get inlined for Copy types in debug mode, so make it inline anyway.

source

fn is<T>() -> bool where
T: Scalar,

Tests if Self the same as the type T Read more

source

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

source

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

source

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

source

pub fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

source

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Struct statrs::distribution::Geometric

Implementations

impl Geometric

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

pub fn p(&self) -> f64

Trait Implementations

impl Clone for Geometric

fn clone(&self) -> Geometric

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

impl Debug for Geometric

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

impl Discrete<u64, f64> for Geometric

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

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

impl DiscreteCDF<u64, f64> for Geometric

fn cdf(&self, x: u64) -> f64

fn inverse_cdf(&self, p: T) -> K

impl Distribution<f64> for Geometric

fn sample<R: Rng + ?Sized>(&self, r: &mut R) -> f64

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where R: Rng,

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where F: Fn(T) -> S,

impl Distribution<f64> for Geometric

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

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

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

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

fn std_dev(&self) -> Option<T>

impl Max<u64> for Geometric

fn max(&self) -> u64

impl Median<f64> for Geometric

fn median(&self) -> f64

impl Min<u64> for Geometric

fn min(&self) -> u64

impl Mode<Option<u64>> for Geometric

fn mode(&self) -> Option<u64>

impl PartialEq<Geometric> for Geometric

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

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

impl Copy for Geometric

impl StructuralPartialEq for Geometric

Auto Trait Implementations

impl RefUnwindSafe for Geometric

impl Send for Geometric

impl Sync for Geometric

impl Unpin for Geometric

impl UnwindSafe for Geometric

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> Scalar for T where T: Copy + PartialEq<T> + Debug + Any,

pub fn inlined_clone(&self) -> T

fn is<T>() -> bool where T: Scalar,

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

pub fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S> where
F: Fn(T) -> S,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,

fn is<T>() -> bool where
T: Scalar,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,