Struct statrs::distribution::Binomial
source · [−]pub struct Binomial { /* private fields */ }
Expand description
Implementations
sourceimpl Binomial
impl Binomial
sourcepub fn new(p: f64, n: u64) -> Result<Binomial>
pub fn new(p: f64, n: u64) -> Result<Binomial>
Constructs a new binomial distribution
with a given p
probability of success of n
trials.
Errors
Returns an error if p
is NaN
, less than 0.0
,
greater than 1.0
, or if n
is less than 0
Examples
use statrs::distribution::Binomial;
let mut result = Binomial::new(0.5, 5);
assert!(result.is_ok());
result = Binomial::new(-0.5, 5);
assert!(result.is_err());
Trait Implementations
sourceimpl Discrete<u64, f64> for Binomial
impl Discrete<u64, f64> for Binomial
sourceimpl DiscreteCDF<u64, f64> for Binomial
impl DiscreteCDF<u64, f64> for Binomial
sourcefn cdf(&self, x: u64) -> f64
fn cdf(&self, x: u64) -> f64
Calculates the cumulative distribution function for the
binomial distribution at x
Formula
I_(1 - p)(n - x, 1 + x)
where I_(x)(a, b)
is the regularized incomplete beta function
sourcefn sf(&self, x: u64) -> f64
fn sf(&self, x: u64) -> f64
Calculates the survival function for the
binomial distribution at x
Formula
I_(p)(x + 1, n - x)
where I_(x)(a, b)
is the regularized incomplete beta function
sourcefn inverse_cdf(&self, p: T) -> K
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
sourceimpl Distribution<f64> for Binomial
impl Distribution<f64> for Binomial
sourcefn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
Generate a random value of T
, using rng
as the source of randomness.
sourcefn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,
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
sourceimpl Distribution<f64> for Binomial
impl Distribution<f64> for Binomial
sourceimpl PartialEq<Binomial> for Binomial
impl PartialEq<Binomial> for Binomial
impl Copy for Binomial
impl StructuralPartialEq for Binomial
Auto Trait Implementations
impl RefUnwindSafe for Binomial
impl Send for Binomial
impl Sync for Binomial
impl Unpin for Binomial
impl UnwindSafe for Binomial
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.