Struct cap_rand::distributions::uniform::UniformFloat

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

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 23 bits of random digits for an f32, and 52 for an f64.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<X> PartialEq<UniformFloat<X>> for UniformFloat<X> where
    X: PartialEq<X>, 

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

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

fn ne(&self, other: &UniformFloat<X>) -> bool

This method tests for !=.

impl UniformSampler for UniformFloat<f64>

type X = f64

The type sampled by this implementation.

fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformFloat<f64> where
    B1: SampleBorrow<<UniformFloat<f64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformFloat<f64> as UniformSampler>::X>, 

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

fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformFloat<f64> where
    B1: SampleBorrow<<UniformFloat<f64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformFloat<f64> as UniformSampler>::X>, 

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

fn sample<R>(&self, rng: &mut R) -> <UniformFloat<f64> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformFloat<f64> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformFloat<f64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformFloat<f64> as UniformSampler>::X>, 

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

fn sample_single_inclusive<R, B1, B2>(low: B1, high: B2, rng: &mut R) -> Self::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<Self::X>,
    B2: SampleBorrow<Self::X>, 

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

impl UniformSampler for UniformFloat<f32>

type X = f32

The type sampled by this implementation.

fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformFloat<f32> where
    B1: SampleBorrow<<UniformFloat<f32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformFloat<f32> as UniformSampler>::X>, 

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

fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformFloat<f32> where
    B1: SampleBorrow<<UniformFloat<f32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformFloat<f32> as UniformSampler>::X>, 

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

fn sample<R>(&self, rng: &mut R) -> <UniformFloat<f32> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformFloat<f32> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformFloat<f32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformFloat<f32> as UniformSampler>::X>, 

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

fn sample_single_inclusive<R, B1, B2>(low: B1, high: B2, rng: &mut R) -> Self::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<Self::X>,
    B2: SampleBorrow<Self::X>, 

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

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

impl<X> StructuralPartialEq for UniformFloat<X>