rand_pcg

Struct Lcg128CmDxsm64

Source
pub struct Lcg128CmDxsm64 { /* private fields */ }
Expand description

A PCG random number generator (CM DXSM 128/64 (LCG) variant).

Permuted Congruential Generator with 128-bit state, internal Linear Congruential Generator, and 64-bit output via “double xorshift multiply” output function.

This is a 128-bit LCG with explicitly chosen stream with the PCG-DXSM output function. This corresponds to pcg_engines::cm_setseq_dxsm_128_64 from pcg_cpp and PCG64DXSM from NumPy.

Despite the name, this implementation uses 32 bytes (256 bit) space comprising 128 bits of state and 128 bits stream selector. These are both set by SeedableRng, using a 256-bit seed.

Note that while two generators with different stream parameter may be closely correlated, this is mitigated by the DXSM output function.

Implementations§

Source§

impl Lcg128CmDxsm64

Source

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

Multi-step advance functions (jump-ahead, jump-back)

The method used here is based on Brown, “Random Number Generation with Arbitrary Stride,”, Transactions of the American Nuclear Society (Nov. 1994). The algorithm is very similar to fast exponentiation.

Even though delta is an unsigned integer, we can pass a signed integer to go backwards, it just goes “the long way round”.

Using this function is equivalent to calling next_64() delta number of times.

Source

pub fn new(state: u128, stream: u128) -> Self

Construct an instance compatible with PCG seed and stream.

Note that the highest bit of the stream parameter is discarded to simplify upholding internal invariants.

Note that while two generators with different stream parameter may be closely correlated, this is mitigated by the DXSM output function.

PCG specifies the following default values for both parameters:

  • state = 0xcafef00dd15ea5e5
  • stream = 0xa02bdbf7bb3c0a7ac28fa16a64abf96

Trait Implementations§

Source§

impl Clone for Lcg128CmDxsm64

Source§

fn clone(&self) -> Lcg128CmDxsm64

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Lcg128CmDxsm64

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Lcg128CmDxsm64

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Lcg128CmDxsm64

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl RngCore for Lcg128CmDxsm64

Source§

fn next_u32(&mut self) -> u32

Return the next random u32. Read more
Source§

fn next_u64(&mut self) -> u64

Return the next random u64. Read more
Source§

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

Fill dest with random data. Read more
Source§

impl SeedableRng for Lcg128CmDxsm64

Source§

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

We use a single 255-bit seed to initialise the state and select a stream. One seed bit (lowest bit of seed[8]) is ignored.

Source§

type Seed = [u8; 32]

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

fn seed_from_u64(state: u64) -> Self

Create a new PRNG using a u64 seed. Read more
Source§

fn from_rng(rng: &mut impl RngCore) -> Self

Create a new PRNG seeded from an infallible Rng. Read more
Source§

fn try_from_rng<R>(rng: &mut R) -> Result<Self, <R as TryRngCore>::Error>
where R: TryRngCore,

Create a new PRNG seeded from a potentially fallible Rng. Read more
Source§

fn from_os_rng() -> Self

Creates a new instance of the RNG seeded via getrandom. Read more
Source§

fn try_from_os_rng() -> Result<Self, Error>

Creates a new instance of the RNG seeded via getrandom without unwrapping potential getrandom errors. Read more
Source§

impl Serialize for Lcg128CmDxsm64

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for Lcg128CmDxsm64

Source§

impl StructuralPartialEq for Lcg128CmDxsm64

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<R> TryRngCore for R
where R: RngCore,

Source§

type Error = Infallible

The type returned in the event of a RNG error.
Source§

fn try_next_u32(&mut self) -> Result<u32, <R as TryRngCore>::Error>

Return the next random u32.
Source§

fn try_next_u64(&mut self) -> Result<u64, <R as TryRngCore>::Error>

Return the next random u64.
Source§

fn try_fill_bytes( &mut self, dst: &mut [u8], ) -> Result<(), <R as TryRngCore>::Error>

Fill dest entirely with random data.
Source§

fn unwrap_err(self) -> UnwrapErr<Self>
where Self: Sized,

Wrap RNG with the UnwrapErr wrapper.
Source§

fn read_adapter(&mut self) -> RngReadAdapter<'_, Self>
where Self: Sized,

Convert an RngCore to a RngReadAdapter.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,