Struct rand_distr::Uniform

pub struct Uniform<X>(/* private fields */)
where
    X: SampleUniform;

Sample values uniformly between two bounds.

Uniform::new and Uniform::new_inclusive construct a uniform distribution sampling from the given range; these functions may do extra work up front to make sampling of multiple values faster. If only one sample from the range is required, Rng::gen_range can be more efficient.

When sampling from a constant range, many calculations can happen at compile-time and all methods should be fast; for floating-point ranges and the full range of integer types, this should have comparable performance to the Standard distribution.

Steps are taken to avoid bias, which might be present in naive implementations; for example rng.gen::<u8>() % 170 samples from the range [0, 169] but is twice as likely to select numbers less than 85 than other values. Further, the implementations here give more weight to the high-bits generated by the RNG than the low bits, since with some RNGs the low-bits are of lower quality than the high bits.

Implementations must sample in [low, high) range for Uniform::new(low, high), i.e., excluding high. In particular, care must be taken to ensure that rounding never results values < low or >= high.

Example

use rand::distr::{Distribution, Uniform};

let between = Uniform::try_from(10..10000).unwrap();
let mut rng = rand::thread_rng();
let mut sum = 0;
for _ in 0..1000 {
    sum += between.sample(&mut rng);
}
println!("{}", sum);

For a single sample, Rng::gen_range may be preferred:

use rand::Rng;

let mut rng = rand::thread_rng();
println!("{}", rng.gen_range(0..10));

Implementations

impl<X> Uniform<X>

where X: SampleUniform,

pub fn new<B1, B2>(low: B1, high: B2) -> Result<Uniform<X>, Error>

where B1: SampleBorrow<X>, B2: SampleBorrow<X>,

Create a new Uniform instance, which samples uniformly from the half open range [low, high) (excluding high).

For discrete types (e.g. integers), samples will always be strictly less than high. For (approximations of) continuous types (e.g. f32, f64), samples may equal high due to loss of precision but may not be greater than high.

Fails if low >= high, or if low, high or the range high - low is non-finite. In release mode, only the range is checked.

pub fn new_inclusive<B1, B2>(low: B1, high: B2) -> Result<Uniform<X>, Error>

where B1: SampleBorrow<X>, B2: SampleBorrow<X>,

Create a new Uniform instance, which samples uniformly from the closed range [low, high] (inclusive).

Fails if low > high, or if low, high or the range high - low is non-finite. In release mode, only the range is checked.

Trait Implementations

impl<X> Clone for Uniform<X>

where X: Clone + SampleUniform, <X as SampleUniform>::Sampler: Clone,

fn clone(&self) -> Uniform<X>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<X> Debug for Uniform<X>

where X: Debug + SampleUniform, <X as SampleUniform>::Sampler: Debug,

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

Formats the value using the given formatter.

impl<'de, X> Deserialize<'de> for Uniform<X>

where X: SampleUniform, <X as SampleUniform>::Sampler: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Uniform<X>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DistString for Uniform<char>

Note: the String is potentially left with excess capacity if the range includes non ascii chars; optionally the user may call string.shrink_to_fit() afterwards.

fn append_string<R>(&self, rng: &mut R, string: &mut String, len: usize)

where R: Rng + ?Sized,

Append len random chars to string

fn sample_string<R>(&self, rng: &mut R, len: usize) -> String

where R: Rng + ?Sized,

Generate a String of len random chars

impl<X> Distribution<X> for Uniform<X>

where X: SampleUniform,

fn sample<R>(&self, rng: &mut R) -> X

where R: Rng + ?Sized,

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

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.

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

impl<X> PartialEq for Uniform<X>

where X: PartialEq + SampleUniform, <X as SampleUniform>::Sampler: PartialEq,

fn eq(&self, other: &Uniform<X>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<X> Serialize for Uniform<X>

where X: SampleUniform, <X as SampleUniform>::Sampler: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<X> TryFrom<Range<X>> for Uniform<X>

where X: SampleUniform,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(r: Range<X>) -> Result<Uniform<X>, Error>

Performs the conversion.

impl<X> TryFrom<RangeInclusive<X>> for Uniform<X>

where X: SampleUniform,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(r: RangeInclusive<X>) -> Result<Uniform<X>, Error>

Performs the conversion.

impl<X> Copy for Uniform<X>

where X: Copy + SampleUniform, <X as SampleUniform>::Sampler: Copy,

impl<X> Eq for Uniform<X>

where X: Eq + SampleUniform, <X as SampleUniform>::Sampler: Eq,

impl<X> StructuralPartialEq for Uniform<X>

where X: SampleUniform,