Struct LinearCongruentialGenerator

pub struct LinearCongruentialGenerator<ANumber: Number> { /* private fields */ }

The classical LCG algorithm. In the most general form it does: X_{n+1} = (X_n * multiplier + increment) % modulus.

Of course, we use 32, 64 and 128 as the modulus, and so we completely skip it and do wrapping arithmetic.

Implementations

impl<ANumber: Number> LinearCongruentialGenerator<ANumber>

pub const fn with_params( multiplier: ANumber, increment: ANumber, initial: ANumber, ) -> Self

Creates a new LCG with the given parameters.

Notes

Both multiplier and increment have to be odd. Moreover, increment should satisfy increment % 4 == 1 condition, otherwise the generator won’t produce full period.

pub fn next_value(&mut self) -> ANumber

Returns the next value of the LCG.

pub fn new(initial: ANumber) -> Self

Creates a new LCG with the given initial value. The remaining parameters are carefuly chosen to maximize generator’s quality.

Trait Implementations

impl<ANumber: Clone + Number> Clone for LinearCongruentialGenerator<ANumber>

fn clone(&self) -> LinearCongruentialGenerator<ANumber>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<ANumber: Debug + Number> Debug for LinearCongruentialGenerator<ANumber>

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

Formats the value using the given formatter.

impl<ANumber: Number> Default for LinearCongruentialGenerator<ANumber>

fn default() -> Self

Returns the “default value” for a type.

impl<ANumber: PartialEq + Number> PartialEq for LinearCongruentialGenerator<ANumber>

fn eq(&self, other: &LinearCongruentialGenerator<ANumber>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<ANumber: Number> PseudoRandomNumberGenerator for LinearCongruentialGenerator<ANumber>

type TNumber = ANumber

fn next_number(&mut self) -> Self::TNumber

Returns the next random number.

fn from_randomness_source( source: &mut impl RandomnessSource<TNumber = Self::TNumber>, ) -> Self

Creates a new PseudoRandomNumberGenerator seeded from a RandomnessSource.

const IS_CRYPTOGRAPHICALLY_SECURE: bool = false

Whether the generator is cryptographically secure.

fn fill_bytes(&mut self, bytes: &mut [u8])

Fills the given mut slice with random bytes.

impl<ANumber: Eq + Number> Eq for LinearCongruentialGenerator<ANumber>

impl<ANumber: Number> StructuralPartialEq for LinearCongruentialGenerator<ANumber>