Struct sprs_rand::rand::distributions::uniform::UniformFloat
source · [−]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
sourceimpl<X> Clone for UniformFloat<X> where
X: Clone,
impl<X> Clone for UniformFloat<X> where
X: Clone,
sourcefn clone(&self) -> UniformFloat<X>
fn clone(&self) -> UniformFloat<X>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<X> Debug for UniformFloat<X> where
X: Debug,
impl<X> Debug for UniformFloat<X> where
X: Debug,
sourceimpl UniformSampler for UniformFloat<f64>
impl UniformSampler for UniformFloat<f64>
sourcefn 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>,
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)
. Read more
sourcefn 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>,
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]
. Read more
sourcefn sample<R>(&self, rng: &mut R) -> <UniformFloat<f64> as UniformSampler>::X where
R: Rng + ?Sized,
fn sample<R>(&self, rng: &mut R) -> <UniformFloat<f64> as UniformSampler>::X where
R: Rng + ?Sized,
Sample a value.
sourcefn 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>,
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)
. Read more
sourceimpl UniformSampler for UniformFloat<f32>
impl UniformSampler for UniformFloat<f32>
sourcefn 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>,
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)
. Read more
sourcefn 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>,
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]
. Read more
sourcefn sample<R>(&self, rng: &mut R) -> <UniformFloat<f32> as UniformSampler>::X where
R: Rng + ?Sized,
fn sample<R>(&self, rng: &mut R) -> <UniformFloat<f32> as UniformSampler>::X where
R: Rng + ?Sized,
Sample a value.
sourcefn 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>,
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)
. Read more
impl<X> Copy for UniformFloat<X> where
X: Copy,
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if self
is actually part of its subset T
(and can be converted to it).
unsafe fn to_subset_unchecked(&self) -> SS
unsafe fn to_subset_unchecked(&self) -> SS
Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts self
to the equivalent element of its superset.