Struct Xoshiro256PlusPlus

pub struct Xoshiro256PlusPlus { /* 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 xoshiro256plusplus.c reference source code by David Blackman and Sebastiano Vigna.

Implementations

impl Xoshiro256PlusPlus

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_xoshiro::rand_core::SeedableRng;
use rand_xoshiro::Xoshiro256PlusPlus;

let rng1 = Xoshiro256PlusPlus::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 Xoshiro256PlusPlus

fn clone(&self) -> Xoshiro256PlusPlus

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Xoshiro256PlusPlus

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

Formats the value using the given formatter.

impl PartialEq for Xoshiro256PlusPlus

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RngCore for Xoshiro256PlusPlus

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.

impl SeedableRng for Xoshiro256PlusPlus

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

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

fn seed_from_u64(seed: u64) -> Xoshiro256PlusPlus

Seed a Xoshiro256PlusPlus from a u64 using SplitMix64.

type Seed = [u8; 32]

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

fn from_rng(rng: &mut impl RngCore) -> Self

Create a new PRNG seeded from an infallible Rng.

fn try_from_rng<R>(rng: &mut R) -> Result<Self, <R as TryRngCore>::Error>

where R: TryRngCore,

Create a new PRNG seeded from a potentially fallible Rng.

fn from_os_rng() -> Self

Creates a new instance of the RNG seeded via getrandom.

fn try_from_os_rng() -> Result<Self, Error>

Creates a new instance of the RNG seeded via getrandom without unwrapping potential getrandom errors.

impl Eq for Xoshiro256PlusPlus

impl StructuralPartialEq for Xoshiro256PlusPlus