Struct oorandom::Rand32

pub struct Rand32 { /* fields omitted */ }

A PRNG producing a 32-bit output.

The current implementation is PCG-XSH-RR.

Methods

impl Rand32

pub const DEFAULT_INC: u64

The default value for increment. This is basically arbitrary, it comes from the PCG reference C implementation: https://github.com/imneme/pcg-c/blob/master/include/pcg_variants.h#L284

pub fn new(seed: u64) -> Self

Creates a new PRNG with the given seed and a default increment.

pub fn new_inc(seed: u64, increment: u64) -> Self

Creates a new PRNG. The two inputs, seed and increment, determine what you get; increment basically selects which sequence of all those possible the PRNG will produce, and the seed selects where in that sequence you start.

Both are arbitrary; increment must be an odd number but this handles that for you

pub fn rand(&mut self) -> u32

Produces a random u32 in the range [0, u32::MAX].

pub fn rand_float(&mut self) -> f32

Produces a random f32 in the range [0.0, 1.0).

pub fn rand_range(&mut self, range: Range<u32>) -> u32

Produces a random within the given bounds. Like any Range, it includes the lower bound and excludes the upper one.

This should be faster than Self::rand() % end + start, but the real advantage is it's more convenient. Requires that range.end <= range.start.

Trait Implementations

impl Debug for Rand32

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

Formats the value using the given formatter.

impl PartialEq<Rand32> for Rand32

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

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

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

This method tests for !=.

impl Copy for Rand32

impl Clone for Rand32

fn clone(&self) -> Rand32

Returns a copy of the value.

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

Performs copy-assignment from source.