Struct Hrng 

pub struct Hrng { /* private fields */ }

Hierarchical random number generator.

Produce deterministic random series of numbers with uniform distribution. Handy to be used for paralelism.

Master random number generator produce children and each child might produce more children as much as dataflows in progam.

Implementations

impl Hrng

pub fn master() -> Self

Construct master hierarchical random number generator with default seed phrase.

Example

use deterministic_rand :: { Hrng, Rng };
let hrng = Hrng ::master();
let rng_ref = hrng.rng_ref();
let mut rng = rng_ref.lock().unwrap();
let got: u64 = rng.gen();

pub fn master_with_seed(seed: Seed) -> Self

Construct hierarchical random number generator with help of seed phrase.

Example

use deterministic_rand :: { Hrng, Rng };
let hrng = Hrng ::master_with_seed( "master1".into() );
let rng_ref = hrng.rng_ref();
let mut rng = rng_ref.lock().unwrap();
let got: u64 = rng.gen();

pub fn rng_ref(&self) -> Arc<Mutex<ChaCha8Rng>>

Get a reference to the current random number generator using a reference counter and mutex.

Returns a shared Arc< Mutex< Generator >>.

Example

let rng_ref = hrng.rng_ref();
let mut rng = rng_ref.lock().unwrap();
let got: u64 = rng.gen();

pub fn child(&self, index: usize) -> Self

Creates new child hierarchical random number generator by index seed.

pub fn _children_len(&self) -> usize

Returns number of children created by this generator. Used only for diagnostics.

Trait Implementations

impl Clone for Hrng

fn clone(&self) -> Hrng

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hrng

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

Formats the value using the given formatter.

impl Default for Hrng

fn default() -> Self

Returns the “default value” for a type.