Struct XorShift8Custom

pub struct XorShift8Custom<const SH1: usize = 3, const SH2: usize = 4, const SH3: usize = 2>(/* private fields */);

Available on crate feature rand only.

A version of XorShift8 that allows customizing the shift values.

It has an 8-bit state and generates 8-bit numbers.

Implementations

impl<const SH1: usize, const SH2: usize, const SH3: usize> XorShift8Custom<SH1, SH2, SH3>

pub const fn new(seed: u8) -> Option<Self>

Returns a seeded XorShift8Custom generator from the given 8-bit seed.

Returns None if seed == 0.

Panics

Panics in debug if either SH1, SH2 or SH3 are < 1 or > 7.

pub const fn new_unchecked(seed: u8) -> Self

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

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

Panics

Panics in debug if either SH1, SH2 or SH3 are < 1 or > 7, or if the seed is 0.

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<const SH1: usize, const SH2: usize, const SH3: usize> XorShift8Custom<SH1, SH2, SH3>

Extra constructors

pub const fn new1_u8(seed: u8) -> Option<Self>

Returns a seeded XorShift8Custom generator from the given 8-bit seed.

This is an alias of new.

Trait Implementations

impl<const SH1: usize, const SH2: usize, const SH3: usize> Clone for XorShift8Custom<SH1, SH2, SH3>

fn clone(&self) -> XorShift8Custom<SH1, SH2, SH3>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const SH1: usize, const SH2: usize, const SH3: usize> ConstDefault for XorShift8Custom<SH1, SH2, SH3>

const DEFAULT: Self

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

impl<const SH1: usize, const SH2: usize, const SH3: usize> Debug for XorShift8Custom<SH1, SH2, SH3>

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

Formats the value using the given formatter.

impl<const SH1: usize, const SH2: usize, const SH3: usize> Default for XorShift8Custom<SH1, SH2, SH3>

fn default() -> Self

Returns the “default value” for a type.

impl<const SH1: usize, const SH2: usize, const SH3: usize> PartialEq for XorShift8Custom<SH1, SH2, SH3>

fn eq(&self, other: &XorShift8Custom<SH1, SH2, SH3>) -> 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<const SH1: usize, const SH2: usize, const SH3: usize> RngCore for XorShift8Custom<SH1, SH2, SH3>

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<const SH1: usize, const SH2: usize, const SH3: usize> SeedableRng for XorShift8Custom<SH1, SH2, SH3>

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; 1]

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<const SH1: usize, const SH2: usize, const SH3: usize> Copy for XorShift8Custom<SH1, SH2, SH3>

impl<const SH1: usize, const SH2: usize, const SH3: usize> Eq for XorShift8Custom<SH1, SH2, SH3>

impl<const SH1: usize, const SH2: usize, const SH3: usize> StructuralPartialEq for XorShift8Custom<SH1, SH2, SH3>