Struct Random 

pub struct Random<R = ThreadRng> { /* private fields */ }

Enhanced random number generator for scientific computing

This is the core random number generator used throughout the SCIRS2 ecosystem. It provides deterministic, high-quality random number generation with support for seeding, thread-local storage, and scientific reproducibility.

Implementations

impl Random<StdRng>

pub fn seed(seed: u64) -> Random<StdRng>

Create a new random number generator with a specific seed

This ensures deterministic behavior across runs, which is critical for scientific reproducibility and testing.

impl<R> Random<R>

where R: Rng,

pub fn sample<T, D>(&mut self, distribution: D) -> T

where D: Distribution<T>,

Sample from a distribution

pub fn gen_range<T, B>(&mut self, range: B) -> T

where T: SampleUniform, B: SampleRange<T>,

Generate a random value in a range

pub fn gen_bool(&mut self, p: f64) -> bool

Generate a random boolean

pub fn fill<T>(&mut self, slice: &mut [T])

where StandardUniform: Distribution<T>,

Fill a slice with random values

pub fn sample_vec<T, D>(&mut self, distribution: D, size: usize) -> Vec<T>

where D: Distribution<T> + Copy,

Generate a vector of random values

pub fn sample_array<T, Dim, D>( &mut self, shape: Dim, distribution: D, ) -> ArrayBase<OwnedRepr<T>, Dim>

where Dim: Dimension, D: Distribution<T> + Copy,

Generate a random array with specified shape and distribution

pub fn rng_mut(&mut self) -> &mut R

Access the underlying RNG (for advanced use cases)

pub fn rng(&self) -> &R

Access the underlying RNG (read-only)

Trait Implementations

impl<R> Debug for Random<R>

where R: Debug,

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

Formats the value using the given formatter.

impl Default for Random

fn default() -> Random

Returns the “default value” for a type.

impl<R> RngCore for Random<R>

where R: RngCore,

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.

impl SeedableRng for Random<StdRng>

type Seed = <StdRng as SeedableRng>::Seed

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

fn from_seed(seed: <Random<StdRng> as SeedableRng>::Seed) -> Random<StdRng>

Create a new PRNG using the given seed.

fn seed_from_u64(state: u64) -> Random<StdRng>

Create a new PRNG using a u64 seed.

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

Create a new PRNG seeded from an infallible Rng.

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.

fn from_os_rng() -> Self

Creates a new instance of the RNG seeded via getrandom.

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

Creates a new instance of the RNG seeded via getrandom without unwrapping potential getrandom errors.