Struct Xoshiro256PlusPlus 

pub struct Xoshiro256PlusPlus { /* private fields */ }

Xoshiro256++ generator state.

Examples

use vrd::xoshiro::Xoshiro256PlusPlus;

let rng = Xoshiro256PlusPlus::from_u64_seed(42);

Implementations

impl Xoshiro256PlusPlus

pub fn from_seed(seed: [u8; 32]) -> Self

Builds an instance from a 32-byte seed, whitened via SplitMix64.

Examples

use vrd::xoshiro::Xoshiro256PlusPlus;

let seed = [0u8; 32];
let mut rng = Xoshiro256PlusPlus::from_seed(seed);
assert_ne!(rng.next_u64(), 0);

pub fn from_u64_seed(seed: u64) -> Self

Convenience constructor from a single u64 seed.

Examples

use vrd::xoshiro::Xoshiro256PlusPlus;

let mut rng = Xoshiro256PlusPlus::from_u64_seed(12345);
assert_ne!(rng.next_u64(), 0);

pub fn next_u64(&mut self) -> u64

Generates the next random u64.

Examples

use vrd::xoshiro::Xoshiro256PlusPlus;

let mut rng = Xoshiro256PlusPlus::from_u64_seed(42);
let n = rng.next_u64();

pub fn next_u32(&mut self) -> u32

Generates the next random u32 by taking the high 32 bits of the next u64.

Examples

use vrd::xoshiro::Xoshiro256PlusPlus;

let mut rng = Xoshiro256PlusPlus::from_u64_seed(42);
let n = rng.next_u32();

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

Fills dest with random bytes.

With the simd feature, large buffers go through a SIMD-batched path that holds K independent Xoshiro256++ lanes in vector registers (K = 2 on AArch64 NEON, K = 4 on x86_64 AVX2). Same seed produces a different byte stream under simd vs. scalar - see crate::xoshiro_simd for the contract.

Examples

use vrd::xoshiro::Xoshiro256PlusPlus;

let mut rng = Xoshiro256PlusPlus::from_u64_seed(42);
let mut buf = [0u8; 16];
rng.fill_bytes(&mut buf);

pub fn jump(&mut self)

Advances the state by 2^128 calls to Self::next_u64.

Examples

use vrd::xoshiro::Xoshiro256PlusPlus;

let mut rng = Xoshiro256PlusPlus::from_u64_seed(42);
rng.jump();

Trait Implementations

impl Clone for Xoshiro256PlusPlus

fn clone(&self) -> Xoshiro256PlusPlus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Xoshiro256PlusPlus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Xoshiro256PlusPlus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Xoshiro256PlusPlus

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 Ord for Xoshiro256PlusPlus

fn cmp(&self, other: &Xoshiro256PlusPlus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Xoshiro256PlusPlus

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Xoshiro256PlusPlus

fn partial_cmp(&self, other: &Xoshiro256PlusPlus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl SeedableRng for Xoshiro256PlusPlus

type Seed = [u8; 32]

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

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

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: &mut R) -> Self

where R: Rng + ?Sized,

Create a new PRNG seeded from an infallible Rng.

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

where R: TryRng + ?Sized,

Create a new PRNG seeded from a potentially fallible Rng.

fn fork(&mut self) -> Self

where Self: Rng,

Fork this PRNG

fn try_fork(&mut self) -> Result<Self, Self::Error>

where Self: TryRng,

Fork this PRNG

impl Serialize for Xoshiro256PlusPlus

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryRng for Xoshiro256PlusPlus

type Error = Infallible

The type returned in the event of a RNG error.

fn try_next_u32(&mut self) -> Result<u32, Self::Error>

Return the next random u32.

fn try_next_u64(&mut self) -> Result<u64, Self::Error>

Return the next random u64.

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Self::Error>

Fill dst entirely with random data.

impl Copy for Xoshiro256PlusPlus

impl Eq for Xoshiro256PlusPlus

impl StructuralPartialEq for Xoshiro256PlusPlus