# [−] [src] Struct rand::distributions::uniform::UniformInt

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

The back-end implementing [`UniformSampler`] for integer types.

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

# Implementation notes

For simplicity, we use the same generic struct `UniformInt<X>` for all integer types `X`. This gives us only one field type, `X`; to store unsigned values of this size, we take use the fact that these conversions are no-ops.

For a closed range, the number of possible numbers we should generate is `range = (high - low + 1)`. To avoid bias, we must ensure that the size of our sample space, `zone`, is a multiple of `range`; other values must be rejected (by replacing with a new random sample).

As a special case, we use `range = 0` to represent the full range of the result type (i.e. for `new_inclusive($ty::MIN, $ty::MAX)`).

The optimum `zone` is the largest product of `range` which fits in our (unsigned) target type. We calculate this by calculating how many numbers we must reject: `reject = (MAX + 1) % range = (MAX - range + 1) % range`. Any (large) product of `range` will suffice, thus in `sample_single` we multiply by a power of 2 via bit-shifting (faster but may cause more rejections).

The smallest integer PRNGs generate is `u32`. For 8- and 16-bit outputs we use `u32` for our `zone` and samples (because it's not slower and because it reduces the chance of having to reject a sample). In this case we cannot store `zone` in the target type since it is too large, however we know `ints_to_reject < range <= $unsigned::MAX`.

An alternative to using a modulus is widening multiply: After a widening multiply by `range`, the result is in the high word. Then comparing the low word against `zone` makes sure our distribution is uniform.

## Trait Implementations

### `impl UniformSampler for UniformInt<i8>` [src]

#### `type X = i8`

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 UniformInt<i16>` [src]

#### `type X = i16`

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 UniformInt<i32>` [src]

#### `type X = i32`

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 UniformInt<i64>` [src]

#### `type X = i64`

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 UniformInt<i128>` [src]

#### `type X = i128`

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 UniformInt<isize>` [src]

#### `type X = isize`

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 UniformInt<u8>` [src]

#### `type X = u8`

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 UniformInt<u16>` [src]

#### `type X = u16`

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 UniformInt<u32>` [src]

#### `type X = u32`

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 UniformInt<u64>` [src]

#### `type X = u64`

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 UniformInt<usize>` [src]

#### `type X = usize`

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 UniformInt<u128>` [src]

#### `type X = u128`

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 UniformInt<X>` [src]

#### `fn clone(&self) -> UniformInt<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 UniformInt<X>` [src]

### `impl<X: Debug> Debug for UniformInt<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 UniformInt<X> where
X: Send,`

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

## Blanket Implementations

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

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

Performs the conversion.

### `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, 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

### `impl<V, T> VZip<V> for T where
V: MultiLane<T>,` [src]

#### `fn vzip(self) -> V` [src]

# 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`)