Struct mini_functions::random::Random

#[non_exhaustive]
pub struct Random {
    pub mt: [u32; 624],
    pub mti: usize,
}

The Random struct is used to generate random numbers using the Mersenne Twister algorithm.

It contains an array of unsigned 32-bit integers and an index used to generate random numbers. The array contains 624 elements and the index is used to generate random numbers from the array.

The index is incremented after each random number is generated. When the index reaches 624, the array is reinitialized and the index is reset to 0.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mt: [u32; 624]

The array of unsigned 32-bit integers used to generate random numbers

mti: usize

The current index of the array used in the generation of random numbers

Implementations

impl Random

pub fn bool(&mut self, probability: f64) -> bool

Returns a random bool with a probability that can be set.

pub fn bytes(&mut self, len: usize) -> Vec<u8>

Returns a vector of random bytes of the given length

pub fn char(&mut self) -> char

Returns a random char within the range ‘a’..=‘z’

pub fn choose<T, 'a>(&'a mut self, values: &'a [T]) -> Option<&'a T>

Returns a random element from a slice of values

pub fn float(&mut self) -> f32

Returns a random float.

pub fn int(&mut self, min: i32, max: i32) -> i32

Returns a random integer within the given range

pub fn uint(&mut self, min: u32, max: u32) -> u32

Returns a random unsigned integer within the given range

pub fn double(&mut self) -> f64

Returns a random double.

pub fn mti(&self) -> usize

Return the value of the mti field

pub fn set_mti(&mut self, value: usize)

Set the value of the mti field

pub fn new() -> Random

Returns new random number generator

pub fn pseudo(&mut self) -> u32

Returns pseudo random number

pub fn rand(&mut self) -> u32

Returns a random 32-bit unsigned integer.

pub fn random_range(&mut self, min: u32, max: u32) -> u32

Returns a random 32-bit unsigned integer within a given range.

pub fn range(&mut self, min: i32, max: i32) -> i32

Returns a random number within a given range.

pub fn seed(&mut self, seed: u32)

Seeds the random number generator with a given value.

pub fn twist(&mut self)

Twists the state of the random number generator.

Trait Implementations

impl Clone for Random

fn clone(&self) -> Random

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Random

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

Formats the value using the given formatter.

impl Default for Random

fn default() -> Random

Returns a default random number generator

impl Display for Random

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

Returns a formatted string representation of the Random struct.

impl Hash for Random

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

where __H: Hasher,

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 Random

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

fn eq(&self, other: &Random) -> 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 Random

fn partial_cmp(&self, other: &Random) -> 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 Eq for Random

impl StructuralEq for Random

impl StructuralPartialEq for Random