Struct randomize::RandRangeU32

pub struct RandRangeU32 { /* fields omitted */ }

An inclusive random range with a u32 low and high value.

This type utilizes u64 math internally, so it's not entirely suitable for 32-bit machines. It'll run, but more slowly than you might like if you're using this in a tight loop.

Methods

impl RandRangeU32

pub fn try_new(a: u32, b: u32) -> Option<Self>

Attempts to make a new inclusive random range. Inputs can be in either order.

Failure

If the inputs are 0 and core::u32::MAX

pub const fn new(a: u32, b: u32) -> Self

As try_new, but const, and panics on failure.

pub const fn low(&self) -> u32

Inclusive low end of this range.

pub const fn high(&self) -> u32

Inclusive high end of this range.

pub fn place_in_range(&self, val: u32) -> Option<u32>

Given a uniform input, produces uniform output in range or fails.

You aren't really intended to use this directly, instead you probably want to use sample.

Failure

Most ranges don't evenly distribute across the u32 space, so some values will fail to end up in range.

pub fn sample(&self, gen: &mut PCG32) -> u32

Sample from a PCG32 one or more times to get a value in range.

Trait Implementations

impl From<Range<u32>> for RandRangeU32

fn from(r: Range<u32>) -> Self

Performs the conversion.

impl From<RangeFrom<u32>> for RandRangeU32

fn from(r: RangeFrom<u32>) -> Self

Performs the conversion.

impl From<RangeFull> for RandRangeU32

fn from(_: RangeFull) -> Self

Performs the conversion.

impl From<RangeInclusive<u32>> for RandRangeU32

fn from(r: RangeInclusive<u32>) -> Self

Performs the conversion.

impl From<RangeTo<u32>> for RandRangeU32

fn from(r: RangeTo<u32>) -> Self

Performs the conversion.

impl From<RangeToInclusive<u32>> for RandRangeU32

fn from(r: RangeToInclusive<u32>) -> Self

Performs the conversion.

impl PartialEq<RandRangeU32> for RandRangeU32

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for RandRangeU32

impl Hash for RandRangeU32

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Debug for RandRangeU32

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

Formats the value using the given formatter.

impl Copy for RandRangeU32

impl Clone for RandRangeU32

fn clone(&self) -> RandRangeU32

Returns a copy of the value.

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

Performs copy-assignment from source.