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

[+] Show declaration

pub struct XorShiftRng { /* fields omitted */ }

[−]

An Xorshift 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.

Marsaglia, George (July 2003). "Xorshift RNGs". Journal of Statistical Software. Vol. 8 (Issue 14). ↩

Methods

`impl XorShiftRng`
[src]
[−]

`pub fn new_unseeded() -> XorShiftRng`
[src]
[−]

Deprecated since 0.5.0

: use the FromEntropy or SeedableRng trait

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, f: &mut Formatter) -> Result`
[src]
[−]

Formats the value using the given formatter. Read more

`impl RngCore 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 fill_bytes(&mut self, dest: &mut [u8])`
[src]
[−]

Fill dest with random data. Read more

`fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>`
[src]
[−]

Fill dest entirely with random data. Read more

`impl SeedableRng for XorShiftRng`
[src]
[+]

`type Seed = [u8; 16]`

Seed type, which is restricted to types mutably-dereferencable as u8 arrays (we recommend [u8; N] for some N). Read more

`fn from_seed(seed: Self::Seed) -> Self`
[src]
[−]

Create a new PRNG using the given seed. Read more

`fn from_rng<R: RngCore>(rng: R) -> Result<Self, Error>`
[src]
[−]

Create a new PRNG seeded from another Rng. Read more

Auto Trait Implementations

`impl Send for XorShiftRng`

`impl Sync for XorShiftRng`

Blanket Implementations

`impl<R> Rng for R where R: RngCore + ?Sized,`
[src]
[+]

`fn gen<T>(&mut self) -> T where Standard: Distribution<T>,`
[src]
[−]

Return a random value supporting the [Standard] distribution. Read more

`fn gen_range<T: PartialOrd + SampleUniform>(&mut self, low: T, high: T) -> T`
[src]
[−]

Generate a random value in the range [low, high), i.e. inclusive of low and exclusive of high. Read more

`fn sample<T, D: Distribution<T>>(&mut self, distr: D) -> T`
[src]
[−]

Sample a new value, using the given distribution. Read more

ⓘImportant traits for DistIter<'a, D, R, T>
Important traits for DistIter<'a, D, R, T>
`impl<'a, D, R, T> Iterator for DistIter<'a, D, R, T> where D: Distribution<T>, R: Rng + 'a, type Item = T;`
`fn sample_iter<'a, T, D: Distribution<T>>( &'a mut self, distr: &'a D ) -> DistIter<'a, D, Self, T> where Self: Sized,`
[src]
[−]

Create an iterator that generates values using the given distribution. Read more

`fn fill<T: AsByteSliceMut + ?Sized>(&mut self, dest: &mut T)`
[src]
[−]

Fill dest entirely with random bytes (uniform value distribution), where dest is any type supporting [AsByteSliceMut], namely slices and arrays over primitive integer types (i8, i16, u32, etc.). Read more

`fn try_fill<T: AsByteSliceMut + ?Sized>( &mut self, dest: &mut T ) -> Result<(), Error>`
[src]
[−]

Fill dest entirely with random bytes (uniform value distribution), where dest is any type supporting [AsByteSliceMut], namely slices and arrays over primitive integer types (i8, i16, u32, etc.). Read more

`fn gen_bool(&mut self, p: f64) -> bool`
[src]
[−]

Return a bool with a probability p of being true. Read more

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

Return a random element from values. Read more

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

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

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

Shuffle a mutable slice in place. Read more

ⓘImportant traits for Generator<T, R>
Important traits for Generator<T, R>
`impl<T, R: RngCore> Iterator for Generator<T, R> where Standard: Distribution<T>, type Item = T;`
`fn gen_iter<T>(&mut self) -> Generator<T, &mut Self> where Standard: Distribution<T>,`
[src]
[−]

Deprecated since 0.5.0

: use Rng::sample_iter(&Standard) instead

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

`fn gen_weighted_bool(&mut self, n: u32) -> bool`
[src]
[−]

Deprecated since 0.5.0

: use gen_bool instead

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

ⓘImportant traits for AsciiGenerator<R>
Important traits for AsciiGenerator<R>
`impl<R: RngCore> Iterator for AsciiGenerator<R> type Item = char;`
`fn gen_ascii_chars(&mut self) -> AsciiGenerator<&mut Self>`
[src]
[−]

Deprecated since 0.5.0

: use sample_iter(&Alphanumeric) instead

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

`impl<R> FromEntropy for R where R: SeedableRng,`
[src]
[+]

`fn from_entropy() -> R`
[src]
[−]

Creates a new instance, automatically seeded with fresh entropy. Read more

`impl<T> From for T`
[src]
[+]

`fn from(t: T) -> T`
[src]
[−]

Performs the conversion.

`impl<T, U> Into for T where U: From<T>,`
[src]
[+]

`fn into(self) -> U`
[src]
[−]

Performs the conversion.

`impl<T> ToOwned for T where T: Clone,`
[src]
[+]

`type Owned = T`

`fn to_owned(&self) -> T`
[src]
[−]

Creates owned data from borrowed data, usually by cloning. Read more

`fn clone_into(&self, target: &mut T)`
[src]
[−]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

`impl<T, U> TryFrom for T where T: From,`
[src]
[+]

`type Error = !`

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`
[src]
[−]

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

`impl<T> Borrow for T where T: ?Sized,`
[src]
[+]

ⓘImportant traits for &'a mut W
Important traits for &'a mut W
`impl<'a, W> Write for &'a mut W where W: Write + ?Sized, impl<'a, R> Read for &'a mut R where R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where I: Iterator + ?Sized, type Item = ::Item;`
`fn borrow(&self) -> &T`
[src]
[−]

Immutably borrows from an owned value. Read more

`impl<T> BorrowMut for T where T: ?Sized,`
[src]
[+]

ⓘImportant traits for &'a mut W
Important traits for &'a mut W
`impl<'a, W> Write for &'a mut W where W: Write + ?Sized, impl<'a, R> Read for &'a mut R where R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where I: Iterator + ?Sized, type Item = ::Item;`
`fn borrow_mut(&mut self) -> &mut T`
[src]
[−]

Mutably borrows from an owned value. Read more

`impl<T, U> TryInto for T where U: TryFrom<T>,`
[src]
[+]

`type Error = >::Error`

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`
[src]
[−]

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

`impl<T> Any for T where T: 'static + ?Sized,`
[src]
[+]

`fn get_type_id(&self) -> TypeId`
[src]
[−]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more

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

Methods

impl XorShiftRng[src][−]

pub fn new_unseeded() -> XorShiftRng[src][−]

Trait Implementations

impl Clone for XorShiftRng[src][+]

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

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

impl Debug for XorShiftRng[src][+]

fn fmt(&self, f: &mut Formatter) -> Result[src][−]

impl RngCore for XorShiftRng[src][+]

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

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

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

fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>[src][−]

impl SeedableRng for XorShiftRng[src][+]

type Seed = [u8; 16]

fn from_seed(seed: Self::Seed) -> Self[src][−]

fn from_rng<R: RngCore>(rng: R) -> Result<Self, Error>[src][−]

Auto Trait Implementations

impl Send for XorShiftRng

impl Sync for XorShiftRng

Blanket Implementations

impl<R> Rng for R where R: RngCore + ?Sized, [src][+]

fn gen<T>(&mut self) -> T where Standard: Distribution<T>, [src][−]

fn gen_range<T: PartialOrd + SampleUniform>(&mut self, low: T, high: T) -> T[src][−]

fn sample<T, D: Distribution<T>>(&mut self, distr: D) -> T[src][−]

Important traits for DistIter<'a, D, R, T>

fn fill<T: AsByteSliceMut + ?Sized>(&mut self, dest: &mut T)[src][−]

fn try_fill<T: AsByteSliceMut + ?Sized>( &mut self, dest: &mut T) -> Result<(), Error>[src][−]

fn gen_bool(&mut self, p: f64) -> bool[src][−]

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

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

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

ⓘImportant traits for Generator<T, R>Important traits for Generator<T, R>impl<T, R: RngCore> Iterator for Generator<T, R> where Standard: Distribution<T>, type Item = T;fn gen_iter<T>(&mut self) -> Generator<T, &mut Self> where Standard: Distribution<T>, [src][−]

Important traits for Generator<T, R>

fn gen_weighted_bool(&mut self, n: u32) -> bool[src][−]

ⓘImportant traits for AsciiGenerator<R>Important traits for AsciiGenerator<R>impl<R: RngCore> Iterator for AsciiGenerator<R> type Item = char;fn gen_ascii_chars(&mut self) -> AsciiGenerator<&mut Self>[src][−]

Important traits for AsciiGenerator<R>

impl<R> FromEntropy for R where R: SeedableRng, [src][+]

fn from_entropy() -> R[src][−]

impl<T> From for T[src][+]

fn from(t: T) -> T[src][−]

impl<T, U> Into for T where U: From<T>, [src][+]

fn into(self) -> U[src][−]

impl<T> ToOwned for T where T: Clone, [src][+]

type Owned = T

fn to_owned(&self) -> T[src][−]

fn clone_into(&self, target: &mut T)[src][−]

impl<T, U> TryFrom for T where T: From<U>, [src][+]

type Error = !

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src][−]

impl<T> Borrow for T where T: ?Sized, [src][+]

Important traits for &'a mut W

impl<T> BorrowMut for T where T: ?Sized, [src][+]

Important traits for &'a mut W

impl<T, U> TryInto for T where U: TryFrom<T>, [src][+]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src][−]

impl<T> Any for T where T: 'static + ?Sized, [src][+]

fn get_type_id(&self) -> TypeId[src][−]

`impl XorShiftRng`
[src]
[−]

`pub fn new_unseeded() -> XorShiftRng`
[src]
[−]

`impl Clone for XorShiftRng`
[src]
[+]

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

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

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

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

`impl RngCore for XorShiftRng`
[src]
[+]

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

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

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

`fn try_fill_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>`
[src]
[−]

`impl SeedableRng for XorShiftRng`
[src]
[+]

`type Seed = [u8; 16]`

`fn from_seed(seed: Self::Seed) -> Self`
[src]
[−]

`fn from_rng<R: RngCore>(rng: R) -> Result<Self, Error>`
[src]
[−]

`impl Send for XorShiftRng`

`impl Sync for XorShiftRng`

`impl<R> Rng for R where R: RngCore + ?Sized,`
[src]
[+]

`fn gen<T>(&mut self) -> T where Standard: Distribution<T>,`
[src]
[−]

`fn gen_range<T: PartialOrd + SampleUniform>(&mut self, low: T, high: T) -> T`
[src]
[−]

`fn sample<T, D: Distribution<T>>(&mut self, distr: D) -> T`
[src]
[−]

`fn fill<T: AsByteSliceMut + ?Sized>(&mut self, dest: &mut T)`
[src]
[−]

`fn try_fill<T: AsByteSliceMut + ?Sized>( &mut self, dest: &mut T ) -> Result<(), Error>`
[src]
[−]

`fn gen_bool(&mut self, p: f64) -> bool`
[src]
[−]

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

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

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

ⓘImportant traits for Generator<T, R>
Important traits for Generator<T, R>
`impl<T, R: RngCore> Iterator for Generator<T, R> where Standard: Distribution<T>, type Item = T;`
`fn gen_iter<T>(&mut self) -> Generator<T, &mut Self> where Standard: Distribution<T>,`
[src]
[−]

`fn gen_weighted_bool(&mut self, n: u32) -> bool`
[src]
[−]

ⓘImportant traits for AsciiGenerator<R>
Important traits for AsciiGenerator<R>
`impl<R: RngCore> Iterator for AsciiGenerator<R> type Item = char;`
`fn gen_ascii_chars(&mut self) -> AsciiGenerator<&mut Self>`
[src]
[−]

`impl<R> FromEntropy for R where R: SeedableRng,`
[src]
[+]

`fn from_entropy() -> R`
[src]
[−]

`impl<T> From for T`
[src]
[+]

`fn from(t: T) -> T`
[src]
[−]

`impl<T, U> Into for T where U: From<T>,`
[src]
[+]

`fn into(self) -> U`
[src]
[−]

`impl<T> ToOwned for T where T: Clone,`
[src]
[+]

`type Owned = T`

`fn to_owned(&self) -> T`
[src]
[−]

`fn clone_into(&self, target: &mut T)`
[src]
[−]

`impl<T, U> TryFrom for T where T: From<U>,`
[src]
[+]

`type Error = !`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`
[src]
[−]

`impl<T> Borrow for T where T: ?Sized,`
[src]
[+]

`impl<T> BorrowMut for T where T: ?Sized,`
[src]
[+]

`impl<T, U> TryInto for T where U: TryFrom<T>,`
[src]
[+]

`type Error = <U as TryFrom<T>>::Error`

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`
[src]
[−]

`impl<T> Any for T where T: 'static + ?Sized,`
[src]
[+]

`fn get_type_id(&self) -> TypeId`
[src]
[−]