Struct LinearCongruentialGenerator 

pub struct LinearCongruentialGenerator { /* private fields */ }

Pseudo-random number generator for uniform distribution.

LaTeX Formula

• N_{i} = (aN_{i-1}+b) mod M

Links

• Wikipedia: https://en.wikipedia.org/wiki/Linear_congruential_generator
• Original Source: https://archive.org/details/proceedings_of_a_second_symposium_on_large-scale_/mode/2up

Examples

use ndarray::Array1;
use digifi::utilities::TEST_ACCURACY;
use digifi::random_generators::{RandomGenerator, LinearCongruentialGenerator};

let lcg: LinearCongruentialGenerator = LinearCongruentialGenerator::new(12_345, 1_000_000, 244_944, 1_597, 51_749);
let sample: Array1<f64> = lcg.generate().unwrap();

assert_eq!(sample.len(), 1_000_000);
assert!((sample.mean().unwrap() - 0.5).abs() < 1_000.0 * TEST_ACCURACY)

Implementations

impl LinearCongruentialGenerator

pub fn new(seed: u32, sample_size: usize, m: u32, a: u32, b: u32) -> Self

Creates a new LinearCongruentialGenerator instance.

Input

• seed: Seed of the generator
• sample_size: Number of pseudo-random numbers to generate
• m: Mod of the linear congruential generator
• a: Multiplierof the linear congruential generator
• b: Increment of the linear congruential generator

Trait Implementations

impl Clone for LinearCongruentialGenerator

fn clone(&self) -> LinearCongruentialGenerator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinearCongruentialGenerator

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

Formats the value using the given formatter.

impl RandomGenerator<LinearCongruentialGenerator> for LinearCongruentialGenerator

fn new_shuffle(sample_size: usize) -> Result<Self, DigiFiError>

Creates a new LinearCongruentialGenerator instance with random parameters.

Input

• sample_size: Number of pseudo-random numbers to generate

fn generate(&self) -> Result<Array1<f64>, DigiFiError>

Array of pseudo-random generated numbers based on Linear Congruential Generator.

Output

• An array pseudo-random numbers following Uniform distribution

impl Copy for LinearCongruentialGenerator