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_xoshiro::rand_core::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.

impl Xoshiro256StarStar

pub fn state(&self) -> [u8; 32]

Return the internal state of the generator as little-endian bytes that can be passed to SeedableRng::from_seed to reconstruct an identical generator.

The all-zero state is unreachable from any non-zero seed, so the round-trip is exact for any generator obtained via the usual constructors. (An all-zero input to from_seed is remapped to seed_from_u64(0).)

Trait Implementations

impl Clone for Xoshiro256StarStar

fn clone(&self) -> Xoshiro256StarStar

Returns a duplicate 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 PartialEq for Xoshiro256StarStar

fn eq(&self, other: &Xoshiro256StarStar) -> 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 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-dereferenceable as u8 arrays (we recommend [u8; N] for some N).

fn from_rng<R>(rng: &mut R) -> Self

where R: Rng + ?Sized,

Create a new PRNG seeded from an infallible Rng.

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

where R: TryRng + ?Sized,

Create a new PRNG seeded from a potentially fallible Rng.

fn fork(&mut self) -> Self

where Self: Rng,

Fork this PRNG

fn try_fork(&mut self) -> Result<Self, Self::Error>

where Self: TryRng,

Fork this PRNG

impl TryRng for Xoshiro256StarStar

type Error = Infallible

The type returned in the event of a RNG error.

fn try_next_u32(&mut self) -> Result<u32, Self::Error>

Return the next random u32.

fn try_next_u64(&mut self) -> Result<u64, Self::Error>

Return the next random u64.

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

Fill dst entirely with random data.

impl Eq for Xoshiro256StarStar

impl StructuralPartialEq for Xoshiro256StarStar