Struct rand::XorShiftRng

[+] Show declaration

pub struct XorShiftRng { /* fields omitted */ }

[−] Expand description

An Xorshift[1] random number generator.

The Xorshift algorithm is not suitable for cryptographic purposes but is very fast. If you do not know for sure that it fits your requirements, use a more secure one such as IsaacRng or OsRng.

[1]: Marsaglia, George (July 2003). "Xorshift RNGs". Journal of Statistical Software. Vol. 8 (Issue 14).

Methods

impl XorShiftRng

[−]

pub fn new_unseeded() -> XorShiftRng

[−]

Creates a new XorShiftRng instance which is not seeded.

The initial values of this RNG are constants, so all generators created by this function will yield the same stream of random numbers. It is highly recommended that this is created through SeedableRng instead of this function

Trait Implementations

impl Clone for XorShiftRng

[+]

fn clone(&self) -> XorShiftRng

[−]

Returns a copy of the value.

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

[−]

Performs copy-assignment from source.

impl Rng for XorShiftRng

[+]

fn next_u32(&mut self) -> u32

[−]

Return the next random u32.

fn next_u64(&mut self) -> u64

[−]

Return the next random u64.

fn next_f32(&mut self) -> f32

[−]

Return the next random f32 selected from the half-open interval [0, 1).

fn next_f64(&mut self) -> f64

[−]

Return the next random f64 selected from the half-open interval [0, 1).

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

[−]

Fill dest with random data.

fn gen<T>(&mut self) -> T where     T: Rand,

[−]

Return a random value of a Rand type.

Important traits for Generator<'a, T, R>

impl<'a, T, R> Iterator for Generator<'a, T, R> where
    R: Rng,
    T: Rand,  type Item = T;

fn gen_iter<T>(&'a mut self) -> Generator<'a, T, Self> where     T: Rand,

[−]

Return an iterator that will yield an infinite number of randomly generated items.

fn gen_range<T>(&mut self, low: T, high: T) -> T where     T: SampleRange + PartialOrd<T>,

[−]

Generate a random value in the range [low, high).

fn gen_weighted_bool(&mut self, n: u32) -> bool

[−]

Return a bool with a 1 in n chance of true

Important traits for AsciiGenerator<'a, R>

impl<'a, R> Iterator for AsciiGenerator<'a, R> where
    R: Rng,  type Item = char;

fn gen_ascii_chars(&'a mut self) -> AsciiGenerator<'a, Self>

[−]

Return an iterator of random characters from the set A-Z,a-z,0-9.

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

[−]

Return a random element from values.

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

[−]

Return a mutable pointer to a random element from values.

fn shuffle<T>(&mut self, values: &mut [T])

[−]

Shuffle a mutable slice in place.

impl Debug for XorShiftRng

[+]

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

[−]

Formats the value using the given formatter.

impl Rand for XorShiftRng

[+]

fn rand<R>(rng: &mut R) -> XorShiftRng where     R: Rng,

[−]

Generates a random instance of this type using the specified source of randomness.

impl SeedableRng<[u32; 4]> for XorShiftRng

[+]

fn reseed(&mut self, seed: [u32; 4])

[−]

Reseed an XorShiftRng. This will panic if seed is entirely 0.

fn from_seed(seed: [u32; 4]) -> XorShiftRng

[−]

Create a new XorShiftRng. This will panic if seed is entirely 0.