Skip to main content

Xoshiro128Plus

Struct Xoshiro128Plus 

Source
pub struct Xoshiro128Plus { /* private fields */ }
Expand description

A xoshiro128+ random number generator.

The xoshiro128+ algorithm is not suitable for cryptographic purposes, but is very fast and has good statistical properties, besides a low linear complexity in the lowest bits.

The algorithm used here is translated from the xoshiro128starstar.c reference source code by David Blackman and Sebastiano Vigna.

Implementations§

Source§

impl Xoshiro128Plus

Source

pub fn jump(&mut self)

Jump forward, equivalently to 2^64 calls to next_u32().

This can be used to generate 2^64 non-overlapping subsequences for parallel computations.

use rand_xoshiro::rand_core::SeedableRng;
use rand_xoshiro::Xoroshiro128StarStar;

let rng1 = Xoroshiro128StarStar::seed_from_u64(0);
let mut rng2 = rng1.clone();
rng2.jump();
let mut rng3 = rng2.clone();
rng3.jump();
Source

pub fn initialize_states(seed: u64, num_states: usize) -> Vec<Self>

Available on non-CUDA only.

Initializes multiple RNG states such that each state corresponds to a subsequence separated by 2**64 steps from eachother in the main sequence. This ensures that as long as no state requests more than 2**64 random numbers, the states are guaranteed to be fully independent.

Trait Implementations§

Source§

impl Clone for Xoshiro128Plus

Source§

fn clone(&self) -> Xoshiro128Plus

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Xoshiro128Plus

Source§

impl Debug for Xoshiro128Plus

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DeviceCopy for Xoshiro128Plus

Source§

impl Eq for Xoshiro128Plus

Source§

impl PartialEq for Xoshiro128Plus

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl RngCore for Xoshiro128Plus

Source§

fn next_u32(&mut self) -> u32

Return the next random u32. Read more
Source§

fn next_u64(&mut self) -> u64

Return the next random u64. Read more
Source§

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

Fill dest with random data. Read more
Source§

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

Fill dest entirely with random data. Read more
Source§

impl SeedableRng for Xoshiro128Plus

Source§

fn from_seed(seed: [u8; 16]) -> Xoshiro128Plus

Create a new Xoshiro128Plus. If seed is entirely 0, it will be mapped to a different seed.

Source§

fn seed_from_u64(seed: u64) -> Xoshiro128Plus

Seed a Xoshiro128Plus from a u64 using SplitMix64.

Source§

type Seed = [u8; 16]

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

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

Create a new PRNG seeded from another Rng. Read more
Source§

impl StructuralPartialEq for Xoshiro128Plus

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> GpuRand for T
where T: RngCore,

Source§

fn uniform_f32(&mut self) -> f32

Creates an f32 in the range of [0.0, 1.0) and advances the state once.
Source§

fn uniform_f64(&mut self) -> f64

Creates an f64 in the range of [0.0, 1.0) and advances the state once.
Source§

fn normal_f32(&mut self) -> f32

Creates an f32 with normal distribution. The value is drawn from a Gaussian of mean=0 and sigma=1 using the Box-Mueller transform. Advances the state twice.
Source§

fn normal_f64(&mut self) -> f64

Creates an f64 with normal distribution. The value is drawn from a Gaussian of mean=0 and sigma=1 using the Box-Mueller transform. Advances the state twice.
Source§

fn normal_f32_2(&mut self) -> [f32; 2]

Same as Self::normal_f32 but doesn’t discard the second normal value.
Source§

fn normal_f64_2(&mut self) -> [f64; 2]

Same as Self::normal_f64 but doesn’t discard the second normal value.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.