Struct vrd::mersenne_twister::MersenneTwisterConfig

pub struct MersenneTwisterConfig {
    pub n: usize,
    pub m: usize,
    pub matrix_a: u32,
    pub upper_mask: u32,
    pub lower_mask: u32,
    pub tempering_mask_b: u32,
    pub tempering_mask_c: u32,
}

Configuration for the Mersenne Twister algorithm.

Fields

n: usize

The number of elements in the array used for the Mersenne Twister algorithm. Its value is set to 624 for optimal performance.

m: usize

The number of elements to skip in the array used for the Mersenne Twister algorithm. Its value is set to 397 for optimal performance.

matrix_a: u32

A constant value used in the Mersenne Twister algorithm.

upper_mask: u32

A constant value used in the Mersenne Twister algorithm.

lower_mask: u32

A constant value used in the Mersenne Twister algorithm.

tempering_mask_b: u32

A constant value used in the Mersenne Twister algorithm.

tempering_mask_c: u32

A constant value used in the Mersenne Twister algorithm.

Implementations

impl MersenneTwisterConfig

Implementation of the MersenneTwisterConfig struct.

pub fn new_custom( n: usize, m: usize, matrix_a: u32, upper_mask: u32, lower_mask: u32, tempering_mask_b: u32, tempering_mask_c: u32 ) -> MersenneTwisterConfig

Creates a new MersenneTwisterConfig with customizable values.

Arguments

• n - The number of elements in the array.
• m - The number of elements to skip.
• matrix_a - Constant value used in the algorithm.
• upper_mask - Constant value used in the algorithm.
• lower_mask - Constant value used in the algorithm.
• tempering_mask_b - Constant value used in the algorithm.
• tempering_mask_c - Constant value used in the algorithm.

Panics

This function panics if any of the provided parameters are outside of their valid range.

Example

use vrd::mersenne_twister::MersenneTwisterConfig;

let config = MersenneTwisterConfig::new_custom(
    624,                // n
    397,                // m
    0x9908b0df,         // matrix_a
    0x80000000,         // upper_mask
    0x7fffffff,         // lower_mask
    0x9d2c5680,         // tempering_mask_b
    0xefc60000          // tempering_mask_c
);

pub fn new() -> MersenneTwisterConfig

Creates a new MersenneTwisterConfig with default values.

Default values are as follows:

• n: 624
• m: 397
• matrix_a: 0x9908b0df
• upper_mask: 0x80000000
• lower_mask: 0x7fffffff
• tempering_mask_b: 0x9d2c5680
• tempering_mask_c: 0xefc60000

Example

use vrd::mersenne_twister::MersenneTwisterConfig;

let config = MersenneTwisterConfig::new();

pub fn set_n(&mut self, n: usize)

Sets the number of elements in the array.

Panics

This function panics if the provided parameter is outside of its valid range.

pub fn set_m(&mut self, m: usize)

Sets the number of elements to skip.

Panics

This function panics if the provided parameter is outside of its valid range.

pub fn set_matrix_a(&mut self, matrix_a: u32)

Sets the matrix_a constant value.

Panics

This function panics if the provided parameter is not valid.

pub fn set_upper_mask(&mut self, upper_mask: u32)

Sets the upper_mask constant value.

Panics

This function panics if the provided parameter is not valid.

pub fn set_lower_mask(&mut self, lower_mask: u32)

Sets the lower_mask constant value.

Panics

This function panics if the provided parameter is not valid.

pub fn set_tempering_mask_b(&mut self, tempering_mask_b: u32)

Sets the tempering_mask_b constant value.

Panics

This function panics if the provided parameter is not valid.

pub fn set_tempering_mask_c(&mut self, tempering_mask_c: u32)

Sets the tempering_mask_c constant value.

Panics

This function panics if the provided parameter is not valid.

Trait Implementations

impl Clone for MersenneTwisterConfig

fn clone(&self) -> MersenneTwisterConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MersenneTwisterConfig

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

Formats the value using the given formatter.

impl Default for MersenneTwisterConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MersenneTwisterConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MersenneTwisterConfig

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

Formats the value using the given formatter.

impl Hash for MersenneTwisterConfig

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 Ord for MersenneTwisterConfig

fn cmp(&self, other: &MersenneTwisterConfig) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MersenneTwisterConfig

fn eq(&self, other: &MersenneTwisterConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for MersenneTwisterConfig

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for MersenneTwisterConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for MersenneTwisterConfig

impl Eq for MersenneTwisterConfig

impl StructuralPartialEq for MersenneTwisterConfig