Struct statrs::distribution::Hypergeometric [−][src]
pub struct Hypergeometric { /* fields omitted */ }
Expand description
Implementations
impl Hypergeometric
[src]
impl Hypergeometric
[src]pub fn new(
population: u64,
successes: u64,
draws: u64
) -> Result<Hypergeometric>
[src]
pub fn new(
population: u64,
successes: u64,
draws: u64
) -> Result<Hypergeometric>
[src]Constructs a new hypergeometric distribution
with a population (N) of population
, number
of successes (K) of successes
, and number of draws
(n) of draws
Errors
If successes > population
or draws > population
Examples
use statrs::distribution::Hypergeometric; let mut result = Hypergeometric::new(2, 2, 2); assert!(result.is_ok()); result = Hypergeometric::new(2, 3, 2); assert!(result.is_err());
pub fn population(&self) -> u64
[src]
pub fn population(&self) -> u64
[src]Returns the population size of the hypergeometric distribution
Examples
use statrs::distribution::Hypergeometric; let n = Hypergeometric::new(10, 5, 3).unwrap(); assert_eq!(n.population(), 10);
Trait Implementations
impl Clone for Hypergeometric
[src]
impl Clone for Hypergeometric
[src]fn clone(&self) -> Hypergeometric
[src]
fn clone(&self) -> Hypergeometric
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for Hypergeometric
[src]
impl Debug for Hypergeometric
[src]impl Discrete<u64, f64> for Hypergeometric
[src]
impl Discrete<u64, f64> for Hypergeometric
[src]impl DiscreteCDF<u64, f64> for Hypergeometric
[src]
impl DiscreteCDF<u64, f64> for Hypergeometric
[src]fn cdf(&self, x: u64) -> f64
[src]
fn cdf(&self, x: u64) -> f64
[src]Calculates the cumulative distribution function for the hypergeometric
distribution at x
Formula
1 - ((n choose k+1) * (N-n choose K-k-1)) / (N choose K) * 3_F_2(1, k+1-K, k+1-n; k+2, N+k+2-K-n; 1)
where N
is population, K
is successes, n
is draws,
and p_F_q
is the [generalized hypergeometric
function](https://en.wikipedia.
org/wiki/Generalized_hypergeometric_function)
fn inverse_cdf(&self, p: T) -> K
[src]
fn inverse_cdf(&self, p: T) -> K
[src]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
impl Distribution<f64> for Hypergeometric
[src]
impl Distribution<f64> for Hypergeometric
[src]impl Distribution<f64> for Hypergeometric
[src]
impl Distribution<f64> for Hypergeometric
[src]fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
[src]
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> f64
[src]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,
[src]
fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,
[src]Create an iterator that generates random values of T
, using rng
as
the source of randomness. Read more
impl Max<u64> for Hypergeometric
[src]
impl Max<u64> for Hypergeometric
[src]impl Min<u64> for Hypergeometric
[src]
impl Min<u64> for Hypergeometric
[src]impl Mode<Option<u64>> for Hypergeometric
[src]
impl Mode<Option<u64>> for Hypergeometric
[src]impl PartialEq<Hypergeometric> for Hypergeometric
[src]
impl PartialEq<Hypergeometric> for Hypergeometric
[src]fn eq(&self, other: &Hypergeometric) -> bool
[src]
fn eq(&self, other: &Hypergeometric) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &Hypergeometric) -> bool
[src]
fn ne(&self, other: &Hypergeometric) -> bool
[src]This method tests for !=
.
impl Copy for Hypergeometric
[src]
impl StructuralPartialEq for Hypergeometric
[src]
Auto Trait Implementations
impl RefUnwindSafe for Hypergeometric
impl Send for Hypergeometric
impl Sync for Hypergeometric
impl Unpin for Hypergeometric
impl UnwindSafe for Hypergeometric
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
pub fn to_subset(&self) -> Option<SS>
pub fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
pub fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
pub fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
pub fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,