Struct pcg::Pcg

pub struct Pcg { /* fields omitted */ }

The Pcg state struct contains state information for use by the random number generating functions.

The internals are private and shouldn't be modified by anything other than the member functions. Note that the random number generating functions will modify the state of this struct, so you must initialize Pcg as mutable in order to use any of its functionality.

Implementations

impl Pcg

pub fn new(seed: u64, seq: u64) -> Pcg

Constructs a new PCG state struct with a particular seed and sequence.

The function returns a struct with state information for the PCG RNG. The seed param supplies an initial state for the RNG, and the seq param functionally acts as a stream ID. If you're unsure of which params to initialize this struct with, construct the default struct.

If you can't think of a seed and a state to initialize this with, just use the default struct.

Examples

use pcg::Pcg;

let mut rng = Pcg::new(0, 0);

Trait Implementations

impl Clone for Pcg

fn clone(&self) -> Pcg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Pcg

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

Formats the value using the given formatter.

impl Default for Pcg

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Pcg

impl PartialEq<Pcg> for Pcg

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

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

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

This method tests for !=.

impl RngCore for Pcg

fn next_u32(&mut self) -> u32

Return the next random u32.

fn next_u64(&mut self) -> u64

Return the next random 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 Pcg

type Seed = PcgSeed

Seed type, which is restricted to types mutably-dereferencable as u8 arrays (we recommend [u8; N] for some N).

fn from_seed(seed: Self::Seed) -> Pcg

Create a new PRNG using the given seed.

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 StructuralEq for Pcg

impl StructuralPartialEq for Pcg