Trait BitGenerator

Source

pub trait BitGenerator: Send {
    // Required methods
    fn next_u64(&mut self) -> u64;
    fn seed_from_u64(seed: u64) -> Self
       where Self: Sized;
    fn jump(&mut self) -> Option<()>;
    fn stream(seed: u64, stream_id: u64) -> Option<Self>
       where Self: Sized;

    // Provided methods
    fn next_f64(&mut self) -> f64 { ... }
    fn next_f32(&mut self) -> f32 { ... }
    fn fill_bytes(&mut self, dest: &mut [u8]) { ... }
    fn next_u64_bounded(&mut self, bound: u64) -> u64 { ... }
}

Expand description

Trait for pluggable pseudo-random number generators.

All BitGenerators are Send (can be transferred between threads) but NOT Sync (they are stateful and require &mut self).

Concrete implementations: Pcg64, Philox, Xoshiro256StarStar.

Required Methods§

Source

fn next_u64(&mut self) -> u64

Generate the next 64-bit unsigned integer.

Source

fn seed_from_u64(seed: u64) -> Self
where Self: Sized,

Create a new generator seeded from a single u64.

Source

fn jump(&mut self) -> Option<()>

Advance the generator state by a large step (2^128 for Xoshiro256**).

Returns Some(()) if jump is supported, None otherwise. After calling jump, the generator’s state has advanced as if 2^128 calls to next_u64 had been made.

Source