Struct MersenneTwisterConfig 

pub struct MersenneTwisterConfig<const N: usize, const M: usize> {
    pub params: MersenneTwisterParams,
}

Configuration for an MT19937-style Mersenne Twister.

N is the array length; M is the recurrence offset. The canonical MT19937 instantiation is MersenneTwisterConfig::<624, 397>.

Examples

use vrd::MersenneTwisterConfig;

let cfg = MersenneTwisterConfig::<624, 397>::default();
assert_eq!(cfg.params.upper_mask, 0x80000000);

Fields

params: MersenneTwisterParams

The validated configuration parameters.

Implementations

impl<const N: usize, const M: usize> MersenneTwisterConfig<N, M>

pub fn new_custom( params: MersenneTwisterParams, ) -> Result<Self, MersenneTwisterError>

Builds a config with custom parameters, validating the invariants.

Examples

use vrd::{MersenneTwisterConfig, MersenneTwisterParams};

let p = MersenneTwisterParams::default();
let cfg = MersenneTwisterConfig::<624, 397>::new_custom(p).unwrap();
assert_eq!(cfg.params, p);

Errors

Returns MersenneTwisterError::InvalidConfig when any parameter (or the N/M const generics) violates a Mersenne-Twister invariant.

pub fn validate( params: &MersenneTwisterParams, ) -> Result<(), MersenneTwisterError>

Validates params against the Mersenne-Twister invariants.

Examples

use vrd::{MersenneTwisterConfig, MersenneTwisterParams};

let p = MersenneTwisterParams::default();
assert!(MersenneTwisterConfig::<624, 397>::validate(&p).is_ok());

// Invalid: M >= N.
assert!(MersenneTwisterConfig::<10, 10>::validate(&p).is_err());

Errors

Returns MersenneTwisterError::InvalidConfig when the invariants are violated. The static message in the error names which one.

pub fn new() -> Result<Self, MersenneTwisterError>

Builds a config using the canonical MT19937 parameters.

Examples

use vrd::MersenneTwisterConfig;

let cfg = MersenneTwisterConfig::<624, 397>::new().unwrap();
assert_eq!(cfg.params.matrix_a, 0x9908b0df);

Errors

Returns MersenneTwisterError::InvalidConfig only if the N/M const generics violate the Mersenne-Twister invariants. MersenneTwisterConfig::<624, 397>::new() is infallible.

pub fn set_config( &mut self, params: MersenneTwisterParams, ) -> Result<(), MersenneTwisterError>

Replaces the parameters in place after re-validating them. On error, the existing parameters are preserved.

Examples

use vrd::{MersenneTwisterConfig, MersenneTwisterParams};

let mut cfg = MersenneTwisterConfig::<624, 397>::default();
cfg.set_config(MersenneTwisterParams::default()).unwrap();

Errors

Returns MersenneTwisterError::InvalidConfig when params fails validation; the existing self.params is left unchanged.

Trait Implementations

impl<const N: usize, const M: usize> Clone for MersenneTwisterConfig<N, M>

fn clone(&self) -> MersenneTwisterConfig<N, M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize, const M: usize> Debug for MersenneTwisterConfig<N, M>

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

Formats the value using the given formatter.

impl Default for MersenneTwisterConfig<624, 397>

fn default() -> Self

Returns the canonical MT19937 configuration.

Examples

use vrd::MersenneTwisterConfig;

let cfg = MersenneTwisterConfig::<624, 397>::default();
assert_eq!(cfg.params.lower_mask, 0x7fffffff);

impl<'de, const N: usize, const M: usize> Deserialize<'de> for MersenneTwisterConfig<N, M>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const N: usize, const M: usize> Display for MersenneTwisterConfig<N, M>

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

Formats the value using the given formatter.

impl<const N: usize, const M: usize> Hash for MersenneTwisterConfig<N, M>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<const N: usize, const M: usize> Ord for MersenneTwisterConfig<N, M>

fn cmp(&self, other: &MersenneTwisterConfig<N, M>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<const N: usize, const M: usize> PartialEq for MersenneTwisterConfig<N, M>

fn eq(&self, other: &MersenneTwisterConfig<N, M>) -> 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<const N: usize, const M: usize> PartialOrd for MersenneTwisterConfig<N, M>

fn partial_cmp(&self, other: &MersenneTwisterConfig<N, M>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<const N: usize, const M: usize> Serialize for MersenneTwisterConfig<N, M>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize, const M: usize> Copy for MersenneTwisterConfig<N, M>

impl<const N: usize, const M: usize> Eq for MersenneTwisterConfig<N, M>

impl<const N: usize, const M: usize> StructuralPartialEq for MersenneTwisterConfig<N, M>