Struct Xorshift

pub struct Xorshift { /* private fields */ }

A random number generator based on 32bits state.

The genrator can be shared and generate random numbers across workers but it doesn’t provide synchronization.

Reference

https://en.wikipedia.org/wiki/Xorshift

Implementations

impl Xorshift

pub const fn new(seed: NonZeroU32) -> Self

Creates a new Xorshift.

Examples

use my_ecs::ds::Xorshift;
use std::num::NonZeroU32;

let gen = Xorshift::new(NonZeroU32::MIN);

pub fn next(&self) -> u32

Generates next random number from the current state.

You can call this method on multiple workers at the same time. The generator is using atomic variable under the hood, so that it’s guaranteed to generate a random number from different states.

Examples

use my_ecs::ds::Xorshift;
use std::{num::NonZeroU32, collections::HashSet};

let gen = Xorshift::new(NonZeroU32::MIN);
let mut randoms = HashSet::new();
for _ in 0..100 {
    let is_new = randoms.insert(gen.next());
    assert!(is_new);
}

Trait Implementations

impl Debug for Xorshift

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

Formats the value using the given formatter.