# [−][src]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`.

## Trait Implementations

### `impl UniformSampler for UniformFloat<f32>`[src]

#### `type X = f32`

The type sampled by this implementation.

#### `fn new<B1, B2>(low_b: B1, high_b: B2) -> Self where
B1: SampleBorrow<Self::X> + Sized,
B2: SampleBorrow<Self::X> + Sized,` [src]

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

#### `fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> Self where
B1: SampleBorrow<Self::X> + Sized,
B2: SampleBorrow<Self::X> + Sized,` [src]

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

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

Sample a value.

#### `fn sample_single<R: Rng + ?Sized, B1, B2>(
low_b: B1,
high_b: B2,
rng: &mut R
) -> Self::X where
B1: SampleBorrow<Self::X> + Sized,
B2: SampleBorrow<Self::X> + Sized,` [src]

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

### `impl UniformSampler for UniformFloat<f64>`[src]

#### `type X = f64`

The type sampled by this implementation.

#### `fn new<B1, B2>(low_b: B1, high_b: B2) -> Self where
B1: SampleBorrow<Self::X> + Sized,
B2: SampleBorrow<Self::X> + Sized,` [src]

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

#### `fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> Self where
B1: SampleBorrow<Self::X> + Sized,
B2: SampleBorrow<Self::X> + Sized,` [src]

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

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

Sample a value.

#### `fn sample_single<R: Rng + ?Sized, B1, B2>(
low_b: B1,
high_b: B2,
rng: &mut R
) -> Self::X where
B1: SampleBorrow<Self::X> + Sized,
B2: SampleBorrow<Self::X> + Sized,` [src]

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

### `impl<X: Clone> Clone for UniformFloat<X>`[src]

#### `fn clone(&self) -> UniformFloat<X>`[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from `source`. Read more

### `impl<X: Copy> Copy for UniformFloat<X>`[src]

### `impl<X: Debug> Debug for UniformFloat<X>`[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

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

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

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

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

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

## Blanket Implementations

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `fn to_owned(&self) -> T`[src]

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

#### `fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

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

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> From<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)