Struct Random 

pub struct Random { /* private fields */ }

A pseudo-random number generator compatible with htm.core.

Uses ChaCha20 for high-quality randomness with deterministic behavior when seeded. The implementation aims to be reproducible across platforms.

Example

use mokosh::utils::Random;

let mut rng = Random::new(42);

// Generate random integers
let n = rng.get_uint32();

// Generate random floats
let f = rng.get_real64();

// Sample from a range
let idx = rng.get_uint32_range(0, 100);

// Shuffle a vector
let mut items: Vec<u32> = (0..10).collect();
rng.shuffle(&mut items);

Implementations

impl Random

pub fn new(seed: i64) -> Self

Creates a new random number generator with the given seed.

If seed is 0, uses a default seed (0 is a valid seed that produces deterministic output).

pub fn with_random_seed() -> Self

Creates a random number generator with a random seed.

pub fn seed(&self) -> u64

Returns the seed used for this generator.

pub fn steps(&self) -> u64

Returns the number of random values generated.

pub fn get_uint32(&mut self) -> u32

Generates a random u32.

pub fn get_uint64(&mut self) -> u64

Generates a random u64.

pub fn get_uint32_range(&mut self, min: u32, max: u32) -> u32

Generates a random u32 in the range [min, max).

pub fn get_uint64_range(&mut self, min: u64, max: u64) -> u64

Generates a random u64 in the range [min, max).

pub fn get_usize(&mut self, n: usize) -> usize

Generates a random usize in the range [0, n).

pub fn get_real32(&mut self) -> f32

Generates a random f32 in [0, 1).

pub fn get_real64(&mut self) -> f64

Generates a random f64 in [0, 1).

pub fn get_real64_range(&mut self, min: f64, max: f64) -> f64

Generates a random f64 in the range [min, max).

pub fn get_bool(&mut self) -> bool

Generates a random boolean with 50% probability.

pub fn get_bool_with_prob(&mut self, probability: f64) -> bool

Generates a random boolean with the given probability of being true.

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

Shuffles a slice in place using Fisher-Yates algorithm.

pub fn sample<T: Clone>(&mut self, items: Vec<T>, k: usize) -> Vec<T>

Samples k unique items from a collection without replacement.

Returns a vector of k randomly selected items from the input. If k >= items.len(), returns a shuffled copy of all items.

pub fn sample_indices(&mut self, n: usize, k: usize) -> Vec<usize>

Samples k indices from 0..n without replacement.

pub fn normal(&mut self, mean: f64, std_dev: f64) -> f64

Returns a normally distributed random number using Box-Muller transform.

pub fn exponential(&mut self, lambda: f64) -> f64

Returns an exponentially distributed random number.

Trait Implementations

impl Clone for Random

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Random

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

Formats the value using the given formatter.

impl Default for Random

fn default() -> Self

Returns the “default value” for a type.