Struct rand::distributions::uniform::UniformFloat

pub struct UniformFloat<X> { /* fields omitted */ }

The back-end implementing UniformSampler for floating-point types.

Unless you are implementing UniformSampler for your own type, this type should not be used directly, use Uniform instead.

Implementation notes

Instead of generating a float in the [0, 1) range using Standard, the UniformFloat implementation converts the output of an PRNG itself. This way one or two steps can be optimized out.

The floats are first converted to a value in the [1, 2) interval using a transmute-based method, and then mapped to the expected range with a multiply and addition. Values produced this way have what equals 22 bits of random digits for an f32, and 52 for an f64.

Currently there is no difference between new and new_inclusive, because the boundaries of a floats range are a bit of a fuzzy concept due to rounding errors.

Trait Implementations

impl<X: Clone> Clone for UniformFloat<X>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<X: Copy> Copy for UniformFloat<X>

impl<X: Debug> Debug for UniformFloat<X>

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

Formats the value using the given formatter.

impl UniformSampler for UniformFloat<f32>

type X = f32

The type sampled by this implementation.

fn new(low: Self::X, high: Self::X) -> Self

Construct self, with inclusive lower bound and exclusive upper bound [low, high).

fn new_inclusive(low: Self::X, high: Self::X) -> Self

Construct self, with inclusive bounds [low, high].

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

Sample a value.

fn sample_single<R: Rng + ?Sized>(
    low: Self::X,
    high: Self::X,
    rng: &mut R
) -> Self::X

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high).

impl UniformSampler for UniformFloat<f64>

type X = f64

The type sampled by this implementation.

fn new(low: Self::X, high: Self::X) -> Self

Construct self, with inclusive lower bound and exclusive upper bound [low, high).

fn new_inclusive(low: Self::X, high: Self::X) -> Self

Construct self, with inclusive bounds [low, high].

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

Sample a value.

fn sample_single<R: Rng + ?Sized>(
    low: Self::X,
    high: Self::X,
    rng: &mut R
) -> Self::X

Sample a single value uniformly from a range with inclusive lower bound and exclusive upper bound [low, high).