# Bernoulli in rand::distributions - Rust
The Bernoulli distribution.
Keywords: rust, rustlang, rust-lang, Bernoulli

# Struct rand::distributions::Bernoulli

source · [−]

    pub struct Bernoulli { /* private fields */ }

Expand description

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).unwrap();
    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.

## Implementations

source

### impl Bernoulli

source

#### pub fn new(p: f64) -> Result<Bernoulli, BernoulliError>

Construct a new `Bernoulli` with the given probability of success `p`.

##### 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`.)

source

#### pub fn from_ratio(
numerator: u32,
denominator: u32
) -> Result<Bernoulli, BernoulliError>

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`.

return `true`. If `numerator == 0` it will always return `false`. For `numerator > denominator` and `denominator == 0`, this returns an error. Otherwise, for `numerator == denominator`, samples are always true; for `numerator == 0` samples are always false.

## Trait Implementations

source

### impl Clone for Bernoulli

source

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

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 Bernoulli

source

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

Formats the value using the given formatter. Read more

source

### impl Distribution<bool> for Bernoulli

source

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

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>ⓘNotable traits for DistIter<D, R, T>`impl<D, R, T> Iterator for DistIter<D, R, T> where
D: Distribution<T>,
R: Rng, type Item = 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<Bernoulli> for Bernoulli

source

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

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

source

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

This method tests for `!=`.

source

### impl Copy for Bernoulli

source

### impl StructuralPartialEq for Bernoulli

## Auto Trait Implementations

### impl RefUnwindSafe for Bernoulli

### impl Send for Bernoulli

### impl Sync for Bernoulli

### impl Unpin for Bernoulli

### impl UnwindSafe for Bernoulli

## Blanket Implementations

source

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

source

#### 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

#### 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

#### 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

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

Returns the argument unchanged.

source

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

const: unstable · 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 T where
T: Clone,

#### 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)

🔬 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<U> for T where
U: Into<T>,

#### type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

source

#### fn vzip(self) -> V