Struct Rng

pub struct Rng { /* private fields */ }

Recommended engine. Currently Xorshift128+.

Implementations

impl Rng

pub fn iter<T: 'static>( &mut self, rand: fn(&mut Self) -> T, ) -> impl '_ + Iterator<Item = T>

A helper function to turn random number generation into an iterator.

Example:

use tiny_rng::{Rng, Rand};

let mut rng = Rng::from_seed(0);
for x in rng.iter(Rand::rand_u32).take(10) {
    println!("0x{:08x}", x);
}

Trait Implementations

impl Rand for Rng

fn from_seed(seed: u64) -> Self

To obtain reproducible results. If feature std is enabled, from_time() may be used instead, to use system time as microseconds as a seed. Apply from_seed(random_seed()) to establish a faster local RNG from a global seed RNG.

fn rand_u64(&mut self) -> u64

A sample from the uniform distribution on 0..=u64::MAX.

fn rand_u32(&mut self) -> u32

A sample from the uniform distribution on 0..=u32::MAX.

fn rand_u8(&mut self) -> u8

A sample from the uniform distribution on 0..=u8::MAX.

fn rand_u16(&mut self) -> u16

A sample from the uniform distribution on 0..=u16::MAX.

fn rand_usize(&mut self) -> usize

A sample from the uniform distribution on 0..=usize::MAX.

fn rand_bounded_u32(&mut self, m: u32) -> u32

A sample from the uniform distribution on 0..m.

fn rand_bounded_u64(&mut self, m: u64) -> u64

A sample from the uniform distribution on 0..m.

fn rand_bounded_usize(&mut self, m: usize) -> usize

A sample from the uniform distribution on 0..m.

fn rand_range_u32(&mut self, a: u32, b: u32) -> u32

A sample from the uniform distribution on a..b.

fn rand_range_u64(&mut self, a: u64, b: u64) -> u64

A sample from the uniform distribution on a..b.

fn rand_range_i32(&mut self, a: i32, b: i32) -> i32

A sample from the uniform distribution on a..b.

fn rand_range_i64(&mut self, a: i64, b: i64) -> i64

A sample from the uniform distribution on a..b.

fn rand_f32(&mut self) -> f32

A sample from the uniform distribution on the interval [0, 1).
⚠️ WARNING: Achieving uniform distribution of floats is complex and requires analysis yet to be accomplished.

fn rand_f64(&mut self) -> f64

A sample from the uniform distribution on the interval [0, 1).
⚠️ WARNING: Achieving uniform distribution of floats is complex and requires analysis yet to be accomplished.

fn choice<'a, T>(&mut self, a: &'a [T]) -> &'a T

A sample from the uniform distribution on the non-empty slice.

fn shuffle<T>(&mut self, a: &mut [T])

Shuffle an array randomly. The method is called Fisher–Yates shuffle and has linear time complexity.

fn fill(&mut self, a: &mut [u8])

Fill a buffer with random bytes.