Struct XorShift64Star 

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

xorshift64*: a 64-bit xorshift state whose output is scrambled by one multiplication (Vigna, “An experimental exploration of Marsaglia’s xorshift generators, scrambled”, ACM TOMS 42(4), 2016). The seed is mixed with the golden-ratio constant and a zero seed is replaced by 1, since the all-zero state is a fixed point of xorshift.

use symplex::XorShift64Star;

assert_eq!(XorShift64Star::new(42).next_u64(), 0x1C28_3E14_F85F_D6CB);
// Seeds 0 and 1 coincide: 0 is not a usable xorshift state.
assert_eq!(XorShift64Star::new(0).next_u64(), XorShift64Star::new(1).next_u64());

Implementations

impl XorShift64Star

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

A generator with the given seed.

pub fn next_u64(&mut self) -> u64

The next 64 random bits.

pub fn next_big_below(&mut self, n: &BigInt) -> BigInt

A big integer uniform in 0..n up to the bias of reducing 64 more random bits than n has (below 2⁻⁶⁴). n must be positive.

Panics

If n is zero (reduction modulo zero).

Trait Implementations

impl Clone for XorShift64Star

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XorShift64Star

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

Formats the value using the given formatter.

impl Eq for XorShift64Star

impl Hash for XorShift64Star

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for XorShift64Star

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for XorShift64Star