Struct rand_xoshiro::Xoshiro512StarStar

[+] Show declaration

pub struct Xoshiro512StarStar { /* fields omitted */ }

[−] Expand description

A xoshiro512** random number generator.

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

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

Implementations

impl Xoshiro512StarStar[−]

pub fn jump(&mut self)[−]

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

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

use rand_xoshiro::rand_core::SeedableRng;
use rand_xoshiro::Xoshiro512StarStar;

let rng1 = Xoshiro512StarStar::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^384 calls to next_u64().

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

Trait Implementations

impl Clone for Xoshiro512StarStar[+]

[+] Show hidden undocumented items

fn clone(&self) -> Xoshiro512StarStar[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Xoshiro512StarStar[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl RngCore for Xoshiro512StarStar[+]

[+] Show hidden undocumented items

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 Xoshiro512StarStar[+]

[+] Show hidden undocumented items

type Seed = Seed512

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

fn from_seed(seed: Seed512) -> Xoshiro512StarStar[−]

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

fn seed_from_u64(seed: u64) -> Xoshiro512StarStar[−]

Seed a Xoshiro512StarStar from a u64 using SplitMix64.

pub fn from_rng<R>(rng: R) -> Result<Self, Error> where
    R: RngCore, [−]

Create a new PRNG seeded from another Rng.

pub fn from_entropy() -> Self[−]

Creates a new instance of the RNG seeded via getrandom.