Struct ndarray_rand::rand::rngs::SmallRng

pub struct SmallRng(_);

A small-state, fast non-crypto PRNG

SmallRng may be a good choice when a PRNG with small state, cheap initialization, good statistical quality and good performance are required. Note that depending on the application, StdRng may be faster on many modern platforms while providing higher-quality randomness. Furthermore, SmallRng is not a good choice when:

• Security against prediction is important. Use StdRng instead.
• Seeds with many zeros are provided. In such cases, it takes SmallRng about 10 samples to produce 0 and 1 bits with equal probability. Either provide seeds with an approximately equal number of 0 and 1 (for example by using SeedableRng::from_entropy or SeedableRng::seed_from_u64), or use StdRng instead.

The algorithm is deterministic but should not be considered reproducible due to dependence on platform and possible replacement in future library versions. For a reproducible generator, use a named PRNG from an external crate, e.g. rand_xoshiro or rand_chacha. Refer also to The Book.

The PRNG algorithm in SmallRng is chosen to be efficient on the current platform, without consideration for cryptography or security. The size of its state is much smaller than StdRng. The current algorithm is Xoshiro256PlusPlus on 64-bit platforms and Xoshiro128PlusPlus on 32-bit platforms. Both are also implemented by the rand_xoshiro crate.

Examples

Initializing SmallRng with a random seed can be done using SeedableRng::from_entropy:

use rand::{Rng, SeedableRng};
use rand::rngs::SmallRng;

// Create small, cheap to initialize and fast RNG with a random seed.
// The randomness is supplied by the operating system.
let mut small_rng = SmallRng::from_entropy();

When initializing a lot of SmallRng’s, using thread_rng can be more efficient:

use rand::{SeedableRng, thread_rng};
use rand::rngs::SmallRng;

// Create a big, expensive to initialize and slower, but unpredictable RNG.
// This is cached and done only once per thread.
let mut thread_rng = thread_rng();
// Create small, cheap to initialize and fast RNGs with random seeds.
// One can generally assume this won't fail.
let rngs: Vec<SmallRng> = (0..10)
    .map(|_| SmallRng::from_rng(&mut thread_rng).unwrap())
    .collect();

Trait Implementations

impl Clone for SmallRng

pub fn clone(&self) -> SmallRng

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SmallRng

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

Formats the value using the given formatter.

impl Eq for SmallRng

impl PartialEq<SmallRng> for SmallRng

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

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

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

This method tests for !=.

impl RngCore for SmallRng

pub fn next_u32(&mut self) -> u32

Return the next random u32.

pub fn next_u64(&mut self) -> u64

Return the next random u64.

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

Fill dest with random data.

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

Fill dest entirely with random data.

impl SeedableRng for SmallRng

type Seed = <Xoshiro256PlusPlus as SeedableRng>::Seed

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

pub fn from_seed(seed: <SmallRng as SeedableRng>::Seed) -> SmallRng

Create a new PRNG using the given seed.

pub fn from_rng<R>(rng: R) -> Result<SmallRng, Error> where
    R: RngCore, 

Create a new PRNG seeded from another Rng.

pub fn seed_from_u64(state: u64) -> Self

Create a new PRNG using a u64 seed.

pub fn from_entropy() -> Self

Creates a new instance of the RNG seeded via getrandom.

impl StructuralEq for SmallRng

impl StructuralPartialEq for SmallRng