Struct urandom::distributions::UniformInt

pub struct UniformInt<T> { /* private fields */ }

Uniform distribution over integral types.

Implementation notes

For simplicity, we use the same generic struct UniformInt<T> for all integer types T. This gives us only one field type, T; 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, is a multiple of range; other values must be rejected (by replacing with a new random sample). See Fast Random Integer Generation in an Interval for the algorithm used.

As a special case, we use range = 0 to represent the full range of the result type (i.e. for the full inclusive range).

For more information on this bias see the examples/int_bias.rs example.

Trait Implementations

impl<T: Clone> Clone for UniformInt<T>

fn clone(&self) -> UniformInt<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for UniformInt<T>

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

Formats the value using the given formatter.

impl Distribution<i16> for UniformInt<i16>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<i32> for UniformInt<i32>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<i64> for UniformInt<i64>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<i8> for UniformInt<i8>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<isize> for UniformInt<isize>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<u16> for UniformInt<u16>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<u32> for UniformInt<u32>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<u64> for UniformInt<u64>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<u8> for UniformInt<u8>

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

Generate a random value of T, using rng as the source of randomness.

impl Distribution<usize> for UniformInt<usize>

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

Generate a random value of T, using rng as the source of randomness.

impl UniformSampler<i16> for UniformInt<i16>

fn new(low: i16, high: i16) -> UniformInt<i16>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: i16, high: i16) -> UniformInt<i16>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<i32> for UniformInt<i32>

fn new(low: i32, high: i32) -> UniformInt<i32>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: i32, high: i32) -> UniformInt<i32>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<i64> for UniformInt<i64>

fn new(low: i64, high: i64) -> UniformInt<i64>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: i64, high: i64) -> UniformInt<i64>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<i8> for UniformInt<i8>

fn new(low: i8, high: i8) -> UniformInt<i8>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: i8, high: i8) -> UniformInt<i8>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<isize> for UniformInt<isize>

fn new(low: isize, high: isize) -> UniformInt<isize>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: isize, high: isize) -> UniformInt<isize>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<u16> for UniformInt<u16>

fn new(low: u16, high: u16) -> UniformInt<u16>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: u16, high: u16) -> UniformInt<u16>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<u32> for UniformInt<u32>

fn new(low: u32, high: u32) -> UniformInt<u32>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: u32, high: u32) -> UniformInt<u32>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<u64> for UniformInt<u64>

fn new(low: u64, high: u64) -> UniformInt<u64>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: u64, high: u64) -> UniformInt<u64>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<u8> for UniformInt<u8>

fn new(low: u8, high: u8) -> UniformInt<u8>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: u8, high: u8) -> UniformInt<u8>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl UniformSampler<usize> for UniformInt<usize>

fn new(low: usize, high: usize) -> UniformInt<usize>

Create a new instance which samples uniformly from the half-open range [low, high) (excluding high). May panic if low >= high.

fn new_inclusive(low: usize, high: usize) -> UniformInt<usize>

Create a new instance which samples uniformly from the closed range [low, high] (inclusive). May panic if low > high.

impl<T: Copy> Copy for UniformInt<T>