Struct Xoshiro256StarStar

pub struct Xoshiro256StarStar { /* private fields */ }

A xoshiro256** random number generator.

The xoshiro256** algorithm is not suitable for cryptographic purposes, but is very fast and has excellent statistical properties.

The algorithm used here is translated from the xoshiro256starstar.c reference source code by David Blackman and Sebastiano Vigna.

Implementations

impl Xoshiro256StarStar

pub fn jump(&mut self)

Jump forward, equivalently to 2^128 calls to next_u64().

This can be used to generate 2^128 non-overlapping subsequences for parallel computations.

use rand::SeedableRng;
use rand_xoshiro::Xoshiro256StarStar;

let rng1 = Xoshiro256StarStar::seed_from_u64(0);
let mut rng2 = rng1.clone();
rng2.jump();
let mut rng3 = rng2.clone();
rng3.jump();

pub fn long_jump(&mut self)

Jump forward, equivalently to 2^192 calls to next_u64().

This can be used to generate 2^64 starting points, from each of which jump() will generate 2^64 non-overlapping subsequences for parallel distributed computations.

Trait Implementations

impl Clone for Xoshiro256StarStar

fn clone(&self) -> Xoshiro256StarStar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Xoshiro256StarStar

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

Formats the value using the given formatter.

impl RngCore for Xoshiro256StarStar

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random u64.

fn fill_bytes(&mut self, dest: &mut [u8])

Fill dest with random data.

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Fill dest entirely with random data.

impl SeedableRng for Xoshiro256StarStar

fn from_seed(seed: [u8; 32]) -> Xoshiro256StarStar

Create a new Xoshiro256StarStar. If seed is entirely 0, it will be mapped to a different seed.

fn seed_from_u64(seed: u64) -> Xoshiro256StarStar

Seed a Xoshiro256StarStar from a u64 using SplitMix64.

type Seed = [u8; 32]

Seed type, which is restricted to types mutably-dereferencable as u8 arrays (we recommend [u8; N] for some N).

fn from_rng<R>(rng: R) -> Result<Self, Error>

where R: RngCore,

Create a new PRNG seeded from another Rng.