Struct Xyza8b

pub struct Xyza8b { /* private fields */ }

Available on crate feature rand only.

A simple 8-bit PRNG with 32-bit of state, based on the XorShift algorithm.

It has an almost optimal cycle so no real care is required for seeding except avoiding all zeros, but it fails many of the die hard random number tests.

Its longest cycle is 4,294,967,294.

Vendored

This is adapted work from 8bit_rng.

Implementations

impl Xyza8b

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

Returns a seeded Xyza8b generator from the given 4 × 8-bit seeds. This is the fastest constructor.

pub const fn inner_state(self) -> [u8; 4]

Returns the PRNG’s inner state as a raw snapshot.

pub const fn from_state(state: [u8; 4]) -> Self

Restores the PRNG from the given state.

pub const fn current_u8(&self) -> u8

Returns the current random u8.

pub fn next_u8(&mut self) -> u8

Returns the next random u8.

pub const fn peek_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 Xyza8b

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 Xyza8b

fn clone(&self) -> Xyza8b

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstDefault for Xyza8b

const DEFAULT: Self

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

impl Debug for Xyza8b

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

Formats the value using the given formatter.

impl Default for Xyza8b

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Xyza8b

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

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.

impl SeedableRng for Xyza8b

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(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.

impl Copy for Xyza8b

impl Eq for Xyza8b

impl StructuralPartialEq for Xyza8b