Struct ndarray_rand::rand_distr::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<X> Clone for UniformInt<X> where
    X: Clone, 

pub fn clone(&self) -> UniformInt<X>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<X> Copy for UniformInt<X> where
    X: Copy, 

impl<X> Debug for UniformInt<X> where
    X: Debug, 

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

Formats the value using the given formatter.

impl UniformSampler for UniformInt<usize>

type X = usize

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<usize> where
    B1: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<usize> where
    B1: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<usize> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<usize> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<usize> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<usize> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<i16>

type X = i16

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i16> where
    B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i16> where
    B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<i16> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i16> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i16> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i16> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<isize>

type X = isize

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<isize> where
    B1: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<isize> where
    B1: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<isize> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<isize> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<isize> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<isize> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<i8>

type X = i8

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i8> where
    B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i8> where
    B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<i8> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i8> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i8> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i8> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<u128>

type X = u128

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u128> where
    B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u128> where
    B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<u128> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u128> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u128> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u128> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<i32>

type X = i32

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i32> where
    B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i32> where
    B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<i32> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i32> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i32> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i32> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<i128>

type X = i128

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i128> where
    B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i128> where
    B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<i128> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i128> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i128> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i128> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<u16>

type X = u16

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u16> where
    B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u16> where
    B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<u16> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u16> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u16> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u16> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<u8>

type X = u8

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u8> where
    B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u8> where
    B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<u8> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u8> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u8> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u8> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<u32>

type X = u32

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u32> where
    B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u32> where
    B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<u32> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u32> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u32> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u32> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<i64>

type X = i64

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i64> where
    B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<i64> where
    B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<i64> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i64> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<i64> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<i64> as UniformSampler>::X>, 

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

impl UniformSampler for UniformInt<u64>

type X = u64

The type sampled by this implementation.

pub fn new<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u64> where
    B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, 

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

pub fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> UniformInt<u64> where
    B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, 

Construct self, with inclusive bounds [low, high].

pub fn sample<R>(&self, rng: &mut R) -> <UniformInt<u64> as UniformSampler>::X where
    R: Rng + ?Sized, 

Sample a value.

pub fn sample_single<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u64> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, 

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

pub fn sample_single_inclusive<R, B1, B2>(
    low_b: B1,
    high_b: B2,
    rng: &mut R
) -> <UniformInt<u64> as UniformSampler>::X where
    R: Rng + ?Sized,
    B1: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>,
    B2: SampleBorrow<<UniformInt<u64> as UniformSampler>::X>, 

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