[−][src]Struct rand::distributions::Bernoulli
The Bernoulli distribution.
This is a special case of the Binomial distribution where n = 1
.
Example
use rand::distributions::{Bernoulli, Distribution}; let d = Bernoulli::new(0.3); let v = d.sample(&mut rand::thread_rng()); println!("{} is from a Bernoulli distribution", v);
Precision
This Bernoulli
distribution uses 64 bits from the RNG (a u64
),
so only probabilities that are multiples of 2-64 can be
represented.
Methods
impl Bernoulli
[src]
pub fn new(p: f64) -> Bernoulli
[src]
Construct a new Bernoulli
with the given probability of success p
.
Panics
If p < 0
or p > 1
.
Precision
For p = 1.0
, the resulting distribution will always generate true.
For p = 0.0
, the resulting distribution will always generate false.
This method is accurate for any input p
in the range [0, 1]
which is
a multiple of 2-64. (Note that not all multiples of
2-64 in [0, 1]
can be represented as a f64
.)
pub fn from_ratio(numerator: u32, denominator: u32) -> Bernoulli
[src]
Construct a new Bernoulli
with the probability of success of
numerator
-in-denominator
. I.e. new_ratio(2, 3)
will return
a Bernoulli
with a 2-in-3 chance, or about 67%, of returning true
.
If numerator == denominator
then the returned Bernoulli
will always
return true
. If numerator == 0
it will always return false
.
Panics
If denominator == 0
or numerator > denominator
.
Trait Implementations
impl Distribution<bool> for Bernoulli
[src]
fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> bool
[src]
ⓘImportant traits for DistIter<'a, D, R, T>fn sample_iter<'a, R>(&'a self, rng: &'a mut R) -> DistIter<'a, Self, R, T> where
Self: Sized,
R: Rng,
[src]
Self: Sized,
R: Rng,
impl Clone for Bernoulli
[src]
impl Copy for Bernoulli
[src]
impl Debug for Bernoulli
[src]
Auto Trait Implementations
impl Send for Bernoulli
impl Unpin for Bernoulli
impl Sync for Bernoulli
impl UnwindSafe for Bernoulli
impl RefUnwindSafe for Bernoulli
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,