Struct dicetest::prand::Prng

pub struct Prng { /* fields omitted */ }

A pseudorandom number generator.

The algorithms are based on this article by Bob Jenkins.

Methods

impl Prng

pub fn from_seed(seed: Seed) -> Prng

Creates a Prng whose internal state is initialized with the given seed.

The result has a satisfying cycle length.

pub fn from_bytes(state_bytes: [u8; 32]) -> Prng

Creates a Prng using the given byte array as internal state.

This function is a left and right inverse for Prng::to_bytes.

A satisfying cycle length is only guaranteed for bytes from Prng::to_bytes called with an Prng that has a satisfying cycle length. Other bytes should not be passed to this function. For initializing an Prng with an arbitrary seed, use Prng::from_seed instead.

pub fn to_bytes(&self) -> [u8; 32]

Returns the internal state as a byte array.

This function is a left and right inverse for Prng::from_bytes.

pub fn next_number(&mut self) -> u64

Returns the next pseudorandom number.

pub fn reseed(&mut self, seed: Seed)

Reinitialze the internal state of self using the current internal state and the given seed.

pub fn fork(&mut self) -> Prng

Splits off a new Prng from self. The internal state of the new Prng is generated with self.

Trait Implementations

impl Eq for Prng

impl Clone for Prng

fn clone(&self) -> Prng

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Prng> for Prng

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Debug for Prng

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

Formats the value using the given formatter.

impl BuildHasher for Prng

type Hasher = SipHasher

Type of the hasher that will be created.

fn build_hasher(&self) -> Self::Hasher

Creates a new hasher.