Struct UniformUsize

pub struct UniformUsize { /* private fields */ }

The back-end implementing UniformSampler for usize.

Implementation notes

Sampling a usize value is usually used in relation to the length of an array or other memory structure, thus it is reasonable to assume that the vast majority of use-cases will have a maximum size under u32::MAX. In part to optimise for this use-case, but mostly to ensure that results are portable across 32-bit and 64-bit architectures (as far as is possible), this implementation will use 32-bit sampling when possible.

Trait Implementations

impl Clone for UniformUsize

fn clone(&self) -> UniformUsize

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UniformUsize

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

Formats the value using the given formatter.

impl PartialEq for UniformUsize

fn eq(&self, other: &UniformUsize) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UniformSampler for UniformUsize

type X = usize

The type sampled by this implementation.

fn new<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformUsize, Error>

where B1: SampleBorrow<<UniformUsize as UniformSampler>::X>, B2: SampleBorrow<<UniformUsize as UniformSampler>::X>,

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

fn new_inclusive<B1, B2>(low_b: B1, high_b: B2) -> Result<UniformUsize, Error>

where B1: SampleBorrow<<UniformUsize as UniformSampler>::X>, B2: SampleBorrow<<UniformUsize as UniformSampler>::X>,

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

fn sample<R>(&self, rng: &mut R) -> usize

where R: Rng + ?Sized,

Sample a value.

fn sample_single<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformUsize as UniformSampler>::X, Error>

where R: Rng + ?Sized, B1: SampleBorrow<<UniformUsize as UniformSampler>::X>, B2: SampleBorrow<<UniformUsize as UniformSampler>::X>,

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

fn sample_single_inclusive<R, B1, B2>( low_b: B1, high_b: B2, rng: &mut R, ) -> Result<<UniformUsize as UniformSampler>::X, Error>

where R: Rng + ?Sized, B1: SampleBorrow<<UniformUsize as UniformSampler>::X>, B2: SampleBorrow<<UniformUsize as UniformSampler>::X>,

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

impl Copy for UniformUsize

impl Eq for UniformUsize

impl StructuralPartialEq for UniformUsize