Struct XorShift128

pub struct XorShift128(/* private fields */);

Available on crate feature rand only.

The XorShift128 pseudo-random number generator.

It has a 128-bit state and generates 64-bit numbers.

Implementations

impl XorShift128

pub const fn new(seeds: [u32; 4]) -> Option<Self>

Returns a seeded XorShift128 generator from the given 4 × 32-bit seeds.

Returns None if all given seeds are 0.

pub const fn new_unchecked(seeds: [u32; 4]) -> Self

Returns a seeded XorShift128 generator from the given 8-bit seed, unchecked.

The seeds must not be all 0, otherwise every result will also be 0.

Panics

Panics in debug if the seeds are all 0.

pub const fn current_u64(&self) -> u64

Returns the current random u64.

pub fn next_u64(&mut self) -> u64

Returns the next random u64.

pub const fn next_state(&self) -> Self

Returns a copy of the next new random state.

pub const fn own_next_u64(self) -> Own<Self, u64>

Returns both the next random state and the u64 value.

impl XorShift128

Extra constructors

pub const fn new1_u128(seed: u128) -> Option<Self>

Available on crate feature split only.

Returns a seeded XorShift128 generator from the given 128-bit seed.

The seeds will be split in little endian order.

pub const fn new2_u64(seeds: [u64; 2]) -> Option<Self>

Available on crate feature split only.

Returns a seeded XorShift128 generator from the given 2 × 64-bit seeds.

The seeds will be split in little endian order.

pub const fn new4_u32(seeds: [u32; 4]) -> Option<Self>

Returns a seeded XorShift128 generator from the given 4 × 32-bit seeds.

This is an alias of new.

pub const fn new8_u16(seeds: [u16; 8]) -> Option<Self>

Available on crate feature join only.

Returns a seeded XorShift128 generator from the given 8 × 16-bit seeds.

The seeds will be joined in little endian order.

pub const fn new16_u8(seeds: [u8; 16]) -> Option<Self>

Returns a seeded XorShift128 generator from the given 16 × 8-bit seeds.

The seeds will be joined in little endian order.

Trait Implementations

impl Clone for XorShift128

fn clone(&self) -> XorShift128

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstDefault for XorShift128

const DEFAULT: Self

Returns the compile-time “default value” for a type.

impl Debug for XorShift128

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

Formats the value using the given formatter.

impl Default for XorShift128

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for XorShift128

fn eq(&self, other: &XorShift128) -> 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 XorShift128

Available on crate feature dep_rand_core only.

fn next_u32(&mut self) -> u32

Returns the next random u32, from the first 32-bits of next_u64.

fn next_u64(&mut self) -> u64

Returns 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 XorShift128

Available on crate feature dep_rand_core only.

fn from_seed(seed: Self::Seed) -> Self

When seeded with zero this implementation uses the default seed value as the cold path.

type Seed = [u8; 16]

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

fn seed_from_u64(state: u64) -> Self

Create a new PRNG using a u64 seed.

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

where R: RngCore,

Create a new PRNG seeded from another Rng.

fn from_entropy() -> Self

Creates a new instance of the RNG seeded via getrandom.

impl Copy for XorShift128

impl Eq for XorShift128

impl StructuralPartialEq for XorShift128