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

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§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de, X> Deserialize<'de> for UniformFloat<X>where
    X: Deserialize<'de>,

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

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

source§

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl UniformSampler for UniformFloat<f32>

§

type X = f32

The type sampled by this implementation.
source§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Selfwhere
    B1: SampleBorrow<Self::X> + Sized,
    B2: SampleBorrow<Self::X> + Sized,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
source§

fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> Selfwhere
    B1: SampleBorrow<Self::X> + Sized,
    B2: SampleBorrow<Self::X> + Sized,

Construct self, with inclusive bounds [low, high]. Read more
source§

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

Sample a value.
source§

fn sample_single<R: Rng + ?Sized, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> Self::Xwhere
    B1: SampleBorrow<Self::X> + Sized,
    B2: SampleBorrow<Self::X> + Sized,

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

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

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

impl UniformSampler for UniformFloat<f64>

§

type X = f64

The type sampled by this implementation.
source§

fn new<B1, B2>(low_b: B1, high_b: B2) -> Selfwhere
    B1: SampleBorrow<Self::X> + Sized,
    B2: SampleBorrow<Self::X> + Sized,

Construct self, with inclusive lower bound and exclusive upper bound [low, high). Read more
source§

fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> Selfwhere
    B1: SampleBorrow<Self::X> + Sized,
    B2: SampleBorrow<Self::X> + Sized,

Construct self, with inclusive bounds [low, high]. Read more
source§

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

Sample a value.
source§

fn sample_single<R: Rng + ?Sized, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> Self::Xwhere
    B1: SampleBorrow<Self::X> + Sized,
    B2: SampleBorrow<Self::X> + Sized,

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

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

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

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

source§

impl<X> StructuralPartialEq for UniformFloat<X>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for Twhere
    T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere
    T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere
    U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for Twhere
    T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere
    U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere
    U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for Twhere
    V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for Twhere
    T: for<'de> Deserialize<'de>,