Struct XorShift16

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

Available on crate feature rand only.

The XorShift16 pseudo-random number generator.

It has a 16-bit state and generates 16-bit numbers.

This is John Metcalf’s 16-bit (7, 8, 9) version of George Marsaglia’s original XorShift32.

Implementations

impl XorShift16

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

Returns a seeded XorShift16 generator from the given 16-bit seed.

Returns None if seed == 0.

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

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

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

pub const fn current_u16(&self) -> u16

Returns the current random u16.

pub fn next_u16(&mut self) -> u16

Returns the next random u16.

pub const fn next_state(&self) -> Self

Returns a copy of the next new random state.

pub const fn own_next_u16(self) -> Own<Self, u16>

Returns both the next random state and the u16 value.

impl XorShift16

Extra constructors

pub const fn new1_u16(seed: u16) -> Option<Self>

Returns a seeded XorShift16 generator from the given 16-bit seed.

This is an alias of new.

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

Returns a seeded XorShift16 generator from the given 2 × 8-bit seeds.

The seeds will be joined in little endian order.

Trait Implementations

impl Clone for XorShift16

fn clone(&self) -> XorShift16

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstDefault for XorShift16

const DEFAULT: Self

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

impl Debug for XorShift16

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

Formats the value using the given formatter.

impl Default for XorShift16

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for XorShift16

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

Available on crate features dep_rand_core and join only.

fn next_u32(&mut self) -> u32

Returns the next 2 × random u16 combined as a single u32.

fn next_u64(&mut self) -> u64

Returns the next 4 × random u16 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 XorShift16

Available on crate features dep_rand_core and join 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; 2]

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 XorShift16

impl Eq for XorShift16

impl StructuralPartialEq for XorShift16