# Struct rand_distr::Hypergeometric

``pub struct Hypergeometric { /* private fields */ }``
Expand description

The hypergeometric distribution `Hypergeometric(N, K, n)`.

This is the distribution of successes in samples of size `n` drawn without replacement from a population of size `N` containing `K` success states.

See the binomial distribution for the analogous distribution for sampling with replacement. It is a good approximation when the population size is much larger than the sample size.

## §Density function

`f(k) = binomial(K, k) * binomial(N-K, n-k) / binomial(N, n)`, where `binomial(a, b) = a! / (b! * (a - b)!)`.

## §Plot

The following plot of the hypergeometric distribution illustrates the probability of drawing `k` successes in `n = 10` draws from a population of `N = 50` items, of which either `K = 12` or `K = 35` are successes.

## §Example

``````use rand_distr::{Distribution, Hypergeometric};

let hypergeo = Hypergeometric::new(60, 24, 7).unwrap();
println!("{} is from a hypergeometric distribution", v);``````

## Implementations§

source§

### impl Hypergeometric

source

#### pub fn new( total_population_size: u64, population_with_feature: u64, sample_size: u64, ) -> Result<Self, Error>

Constructs a new `Hypergeometric` with the shape parameters `N = total_population_size`, `K = population_with_feature`, `n = sample_size`.

## Trait Implementations§

source§

### impl Clone for Hypergeometric

source§

#### fn clone(&self) -> Hypergeometric

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 Hypergeometric

source§

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

Formats the value using the given formatter. Read more
source§

### impl<'de> Deserialize<'de> for Hypergeometric

source§

#### fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

### impl Distribution<u64> for Hypergeometric

source§

#### fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> u64

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, Self: Sized,

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, Self: Sized,

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

### impl PartialEq for Hypergeometric

source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl Serialize for Hypergeometric

source§

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

Serialize this value into the given Serde serializer. Read more
source§

source§

§

§

§

§

§

§

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> CloneToUninit for Twhere T: Clone,

source§

#### unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dst`. Read more
source§

### impl<T> From<T> for T

source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere U: From<T>,

source§

#### 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> ToOwned for Twhere T: Clone,

source§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

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

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

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

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

source§

#### type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

source§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

source§

source§