Struct Xyza8a

pub struct Xyza8a { /* private fields */ }

Available on crate feature rand only.

A simple 8-bit pseudo-random number generator with 32-bit of state, based on the XorShift algorithm.

It has a 0.8% chance of falling into a poor quality short chain, a some degree of care is required to seed it. However, the quality of the random numbers is excellent for such a small state (32 bits), and it passes almost all of the die hard tests.

Its longest cycle is 4_261_412_736.

License

This algorithm was ported from 8bit_rng. Copyright (c) 2008-2013 Edward Rosten. Licensed under the BSD 2-Clause “Simplified” License

Implementations

impl Xyza8a

pub const fn new(seeds: [u8; 4]) -> Self

Returns a seeded Xyza8a generator from the given 4 × 8-bit seeds.

pub const fn current_u8(&self) -> u8

Returns the current random u8.

pub fn next_u8(&mut self) -> u8

Updates the state and returns the next random u8.

pub const fn next_state(&self) -> Self

Returns a copy of the next new random state.

pub const fn own_next_u8(self) -> Own<Self, u8>

Returns both the next random state and the u8 value.

impl Xyza8a

Extra constructors

pub const fn new1_u32(seed: u32) -> Self

Returns a seeded Xyza8a generator from the given 32-bit seed.

The seeds will be split in little endian order.

pub const fn new2_u16(seeds: [u16; 2]) -> Self

Returns a seeded Xyza8a generator from the given 2 × 16-bit seeds.

The seeds will be split in little endian order.

pub const fn new4_u8(seeds: [u8; 4]) -> Self

Returns a seeded Xyza8b generator from the given 4 × 8-bit seeds. This is an alias of new.

Trait Implementations

impl Clone for Xyza8a

fn clone(&self) -> Xyza8a

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstDefault for Xyza8a

const DEFAULT: Self

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

impl Debug for Xyza8a

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

Formats the value using the given formatter.

impl Default for Xyza8a

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Xyza8a

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

Available on crate feature dep_rand_core only.

fn next_u32(&mut self) -> u32

Returns the next 4 × random u8 combined as a single u32.

fn next_u64(&mut self) -> u64

Returns the next 8 × random u8 combined as a single 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 Xyza8a

Available on crate feature dep_rand_core only.

type Seed = [u8; 4]

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

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

Create a new PRNG using the given seed.

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 Xyza8a

impl Eq for Xyza8a

impl StructuralPartialEq for Xyza8a