Skip to main content

Rng

Struct Rng 

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

A fast, high-quality pseudo-random number generator.

Uses the xoshiro256** algorithm (Blackman & Vigna), which has a period of 2^256 − 1 and passes all BigCrush tests.

§Examples

use scivex_core::random::Rng;

let mut rng = Rng::new(42);
let value = rng.next_f64(); // uniform in [0, 1)
assert!((0.0..1.0).contains(&value));

Implementations§

Source§

impl Rng

Source

pub fn new(seed: u64) -> Self

Create a new PRNG seeded from a single u64.

The seed is expanded into the 4-word internal state via SplitMix64.

Source

pub fn seed(&mut self, seed: u64)

Re-seed the generator, discarding all previous state.

§Examples
use scivex_core::random::Rng;
let mut rng = Rng::new(1);
let first = rng.next_u64();
rng.seed(1);
assert_eq!(rng.next_u64(), first);
Source

pub fn fork(&mut self, n: usize) -> Vec<Self>

Create n independent child RNGs by advancing the state.

Each child receives a unique seed derived from the parent’s state. This is useful for parallel workloads where each thread needs its own RNG to avoid contention.

§Examples
use scivex_core::random::Rng;
let mut rng = Rng::new(42);
let children = rng.fork(4);
assert_eq!(children.len(), 4);
Source

pub fn next_u64(&mut self) -> u64

Generate the next random u64.

§Examples
use scivex_core::random::Rng;
let mut rng = Rng::new(1);
let v = rng.next_u64(); // some pseudo-random u64
let _ = v; // value is deterministic but not checked here
Source

pub fn next_f64(&mut self) -> f64

Generate a random f64 uniformly distributed in [0, 1).

Uses the upper 53 bits of next_u64 divided by 2^53.

Source

pub fn next_normal_f64(&mut self) -> f64

Generate a standard normal (N(0,1)) f64 via the Ziggurat algorithm.

~97% of samples require only a multiply and comparison (no transcendentals), making this much faster than Box-Muller.

§Examples
use scivex_core::random::Rng;
let mut rng = Rng::new(0);
// Draw 1000 samples and verify mean is near 0
let mean: f64 = (0..1000).map(|_| rng.next_normal_f64()).sum::<f64>() / 1000.0;
assert!(mean.abs() < 0.2);

Auto Trait Implementations§

§

impl Freeze for Rng

§

impl RefUnwindSafe for Rng

§

impl Send for Rng

§

impl Sync for Rng

§

impl Unpin for Rng

§

impl UnsafeUnpin for Rng

§

impl UnwindSafe for Rng

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> 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, 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.