# [−] [src] Struct rand::distributions::Bernoulli

    pub struct Bernoulli { /* fields omitted */ }

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.

## Methods

### `impl Bernoulli` [src]

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

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

#### `pub fn from_ratio(
numerator: u32,
denominator: u32
) -> Result<Bernoulli, BernoulliError>` [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`.

## Trait Implementations

### `impl Distribution<bool> for Bernoulli` [src]

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

Generate a random value of `T`, using `rng` as the source of randomness.

####
ⓘImportant traits for DistIter<D, R, T>

### Important 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;`
`fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T> where
R: Rng,
Self: Sized,` [src]

Create an iterator that generates random values of `T`, using `rng` as the source of randomness. Read more

### `impl Clone for Bernoulli` [src]

#### `fn clone(&self) -> Bernoulli` [src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl Copy for Bernoulli` [src]

### `impl Debug for Bernoulli` [src]

#### `fn fmt(&self, f: &mut Formatter) -> Result` [src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl Send for Bernoulli`

### `impl Sync for Bernoulli`

## Blanket Implementations

### `impl<T> From<T> for T` [src]

#### `fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T` [src]

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

#### `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<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U` [src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

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

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId` [src]

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

### `impl<V, T> VZip<V> for T where
V: MultiLane<T>,` [src]

#### `fn vzip(self) -> V` [src]

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)