Struct randomize::PCG64

pub struct PCG64 {
    pub state: u128,
    pub inc: u128,
}

A permuted congruential generator with 64-bit output. Pick this if you want to do stuff with f64 values.

Fields

state: u128

State value. Changes with every use.

inc: u128

Inc value. Selects the output stream ordering.

This doesn't change as the generator is used. You just set it and forget it. If this value isn't odd, your generator won't have a full period before it loops. The seed constructor will ensure that the inc value is set to be odd, but the From constructors will not.

Methods

impl PCG64

pub const fn seed(seed: u128, inc: u128) -> Self

Crates a generator from the seed and inc given.

The precise seeding details are not considered a "stable" part of the API.

If you wish to exactly create a generator using particular state and inc values then use the From impl.

pub fn next_u64(&mut self) -> u64

Runs the generator once and gets a u64 as output.

pub fn fill_bytes(&mut self, bytes: &mut [u8])

Fill a mutable byte slice from this generator.

pub fn jump(&mut self, delta: u128)

Advances the generator delta steps in log(delta) time.

Trait Implementations

impl From<[u128; 2]> for PCG64

fn from(value: [u128; 2]) -> Self

Uses the provided values exactly.

impl From<(u128, u128)> for PCG64

fn from(value: (u128, u128)) -> Self

Uses the provided values exactly.

impl From<PCG64> for [u128; 2]

fn from(pcg: PCG64) -> Self

Performs the conversion.

impl From<PCG64> for (u128, u128)

fn from(pcg: PCG64) -> Self

Performs the conversion.

impl PartialEq<PCG64> for PCG64

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

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

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

This method tests for !=.

impl Eq for PCG64

impl Hash for PCG64

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for PCG64

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

Formats the value using the given formatter.

impl Clone for PCG64

fn clone(&self) -> PCG64

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PCG64

fn default() -> Self

Returns the "default value" for a type.