Struct rand::distributions::Uniform

pub struct Uniform;

A generic random value distribution. Generates values for various types with numerically uniform distribution.

For floating-point numbers, this generates values from the open range (0, 1) (i.e. excluding 0.0 and 1.0).

Built-in Implementations

This crate implements the distribution Uniform for various primitive types. Assuming the provided Rng is well-behaved, these implementations generate values with the following ranges and distributions:

• Integers (i32, u32, isize, usize, etc.): Uniformly distributed over all values of the type.
• char: Uniformly distributed over all Unicode scalar values, i.e. all code points in the range 0...0x10_FFFF, except for the range 0xD800...0xDFFF (the surrogate code points). This includes unassigned/reserved code points.
• bool: Generates false or true, each with probability 0.5.
• Floating point types (f32 and f64): Uniformly distributed in the open range (0, 1).

The following aggregate types also implement the distribution Uniform as long as their component types implement it:

• Tuples and arrays: Each element of the tuple or array is generated independently, using the Uniform distribution recursively.
• Option<T>: Returns None with probability 0.5; otherwise generates a random T and returns Some(T).

Example

use rand::{NewRng, SmallRng, Rng};
use rand::distributions::Uniform;

let val: f32 = SmallRng::new().sample(Uniform);
println!("f32 from [0,1): {}", val);

With dynamic dispatch (type erasure of Rng):

use rand::{thread_rng, Rng, RngCore};
use rand::distributions::Uniform;

let mut rng = thread_rng();
let mut erased_rng: &mut RngCore = &mut rng;
let val: f32 = erased_rng.sample(Uniform);
println!("f32 from [0,1): {}", val);

Trait Implementations

impl Distribution<f32> for Uniform

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

Generate a floating point number in the open interval (0, 1) (not including either endpoint) with a uniform distribution.

Example

use rand::{NewRng, SmallRng, Rng};
use rand::distributions::Uniform;

let val: f32 = SmallRng::new().sample(Uniform);
println!("f32 from (0,1): {}", val);

impl Distribution<f64> for Uniform

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

Generate a floating point number in the open interval (0, 1) (not including either endpoint) with a uniform distribution.

Example

use rand::{NewRng, SmallRng, Rng};
use rand::distributions::Uniform;

let val: f32 = SmallRng::new().sample(Uniform);
println!("f32 from (0,1): {}", val);

impl Distribution<isize> for Uniform

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

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

impl Distribution<i8> for Uniform

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

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

impl Distribution<i16> for Uniform

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

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

impl Distribution<i32> for Uniform

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

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

impl Distribution<i64> for Uniform

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

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

impl Distribution<usize> for Uniform

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

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

impl Distribution<u8> for Uniform

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

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

impl Distribution<u16> for Uniform

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

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

impl Distribution<u32> for Uniform

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

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

impl Distribution<u64> for Uniform

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

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

impl Distribution<char> for Uniform

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

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

impl Distribution<bool> for Uniform

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

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

impl Distribution<()> for Uniform

fn sample<R: Rng + ?Sized>(&self, _: &mut R)

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

impl<A> Distribution<(A,)> for Uniform where
    Uniform: Distribution<A>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A,)

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

impl<A, B> Distribution<(A, B)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B)

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

impl<A, B, C> Distribution<(A, B, C)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B, C)

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

impl<A, B, C, D> Distribution<(A, B, C, D)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B, C, D)

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

impl<A, B, C, D, E> Distribution<(A, B, C, D, E)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B, C, D, E)

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

impl<A, B, C, D, E, F> Distribution<(A, B, C, D, E, F)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>,
    Uniform: Distribution<F>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B, C, D, E, F)

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

impl<A, B, C, D, E, F, G> Distribution<(A, B, C, D, E, F, G)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>,
    Uniform: Distribution<F>,
    Uniform: Distribution<G>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B, C, D, E, F, G)

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

impl<A, B, C, D, E, F, G, H> Distribution<(A, B, C, D, E, F, G, H)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>,
    Uniform: Distribution<F>,
    Uniform: Distribution<G>,
    Uniform: Distribution<H>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B, C, D, E, F, G, H)

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

impl<A, B, C, D, E, F, G, H, I> Distribution<(A, B, C, D, E, F, G, H, I)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>,
    Uniform: Distribution<F>,
    Uniform: Distribution<G>,
    Uniform: Distribution<H>,
    Uniform: Distribution<I>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> (A, B, C, D, E, F, G, H, I)

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

impl<A, B, C, D, E, F, G, H, I, J> Distribution<(A, B, C, D, E, F, G, H, I, J)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>,
    Uniform: Distribution<F>,
    Uniform: Distribution<G>,
    Uniform: Distribution<H>,
    Uniform: Distribution<I>,
    Uniform: Distribution<J>, 

fn sample<R: Rng + ?Sized>(
    &self,
    _rng: &mut R
) -> (A, B, C, D, E, F, G, H, I, J)

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

impl<A, B, C, D, E, F, G, H, I, J, K> Distribution<(A, B, C, D, E, F, G, H, I, J, K)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>,
    Uniform: Distribution<F>,
    Uniform: Distribution<G>,
    Uniform: Distribution<H>,
    Uniform: Distribution<I>,
    Uniform: Distribution<J>,
    Uniform: Distribution<K>, 

fn sample<R: Rng + ?Sized>(
    &self,
    _rng: &mut R
) -> (A, B, C, D, E, F, G, H, I, J, K)

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

impl<A, B, C, D, E, F, G, H, I, J, K, L> Distribution<(A, B, C, D, E, F, G, H, I, J, K, L)> for Uniform where
    Uniform: Distribution<A>,
    Uniform: Distribution<B>,
    Uniform: Distribution<C>,
    Uniform: Distribution<D>,
    Uniform: Distribution<E>,
    Uniform: Distribution<F>,
    Uniform: Distribution<G>,
    Uniform: Distribution<H>,
    Uniform: Distribution<I>,
    Uniform: Distribution<J>,
    Uniform: Distribution<K>,
    Uniform: Distribution<L>, 

fn sample<R: Rng + ?Sized>(
    &self,
    _rng: &mut R
) -> (A, B, C, D, E, F, G, H, I, J, K, L)

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

impl<T> Distribution<[T; 0]> for Uniform

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 0]

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

impl<T> Distribution<[T; 1]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 1]

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

impl<T> Distribution<[T; 2]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 2]

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

impl<T> Distribution<[T; 3]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 3]

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

impl<T> Distribution<[T; 4]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 4]

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

impl<T> Distribution<[T; 5]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 5]

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

impl<T> Distribution<[T; 6]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 6]

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

impl<T> Distribution<[T; 7]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 7]

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

impl<T> Distribution<[T; 8]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 8]

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

impl<T> Distribution<[T; 9]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 9]

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

impl<T> Distribution<[T; 10]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 10]

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

impl<T> Distribution<[T; 11]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 11]

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

impl<T> Distribution<[T; 12]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 12]

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

impl<T> Distribution<[T; 13]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 13]

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

impl<T> Distribution<[T; 14]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 14]

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

impl<T> Distribution<[T; 15]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 15]

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

impl<T> Distribution<[T; 16]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 16]

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

impl<T> Distribution<[T; 17]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 17]

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

impl<T> Distribution<[T; 18]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 18]

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

impl<T> Distribution<[T; 19]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 19]

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

impl<T> Distribution<[T; 20]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 20]

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

impl<T> Distribution<[T; 21]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 21]

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

impl<T> Distribution<[T; 22]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 22]

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

impl<T> Distribution<[T; 23]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 23]

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

impl<T> Distribution<[T; 24]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 24]

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

impl<T> Distribution<[T; 25]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 25]

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

impl<T> Distribution<[T; 26]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 26]

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

impl<T> Distribution<[T; 27]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 27]

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

impl<T> Distribution<[T; 28]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 28]

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

impl<T> Distribution<[T; 29]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 29]

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

impl<T> Distribution<[T; 30]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 30]

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

impl<T> Distribution<[T; 31]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 31]

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

impl<T> Distribution<[T; 32]> for Uniform where
    Uniform: Distribution<T>, 

fn sample<R: Rng + ?Sized>(&self, _rng: &mut R) -> [T; 32]

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

impl<T> Distribution<Option<T>> for Uniform where
    Uniform: Distribution<T>, 

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

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

impl Debug for Uniform

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.