rand::XorShiftRng - Rust
Description: API documentation for the Rust `XorShiftRng` struct in crate `rand`.
Keywords: rust, rustlang, rust-lang, XorShiftRng

# Struct rand::XorShiftRng [−] [src]

    pub struct XorShiftRng { /* fields omitted */ }

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`
[src]

#### `fn new_unseeded() -> XorShiftRng`
[src]

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`
[src]

#### `fn clone(&self) -> XorShiftRng`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
1.0.0
[src]

Performs copy-assignment from `source`. Read more

### `impl Debug for XorShiftRng`
[src]

#### `fn fmt(&self, __arg_0: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl Rng for XorShiftRng`
[src]

#### `fn next_u32(&mut self) -> u32`
[src]

Return the next random u32. Read more

#### `fn next_u64(&mut self) -> u64`
[src]

Return the next random u64. Read more

#### `fn next_f32(&mut self) -> f32`
[src]

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

#### `fn next_f64(&mut self) -> f64`
[src]

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

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

Fill `dest` with random data. Read more

#### `fn gen<T: Rand>(&mut self) -> T where
Self: Sized,`
[src]

Return a random value of a `Rand` type. Read more

#### `fn gen_iter<'a, T: Rand>(&'a mut self) -> Generator<'a, T, Self> where
Self: Sized,`
[src]

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

#### `fn gen_range<T: PartialOrd + SampleRange>(&mut self, low: T, high: T) -> T where
Self: Sized,`
[src]

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

#### `fn gen_weighted_bool(&mut self, n: u32) -> bool where
Self: Sized,`
[src]

Return a bool with a 1 in n chance of true Read more

#### `fn gen_ascii_chars<'a>(&'a mut self) -> AsciiGenerator<'a, Self> where
Self: Sized,`
[src]

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

#### `fn choose<'a, T>(&mut self, values: &'a [T]) -> Option<&'a T> where
Self: Sized,`
[src]

Return a random element from `values`. Read more

#### `fn choose_mut<'a, T>(&mut self, values: &'a mut [T]) -> Option<&'a mut T> where
Self: Sized,`
[src]

Return a mutable pointer to a random element from `values`. Read more

#### `fn shuffle<T>(&mut self, values: &mut [T]) where
Self: Sized,`
[src]

Shuffle a mutable slice in place. Read more

### `impl SeedableRng<[u32; 4]> for XorShiftRng`
[src]

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

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

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

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

### `impl Rand for XorShiftRng`
[src]

#### `fn rand<R: Rng>(rng: &mut R) -> XorShiftRng`
[src]

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

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)