Xoroshiro128PlusPlus Class

Represents a pseudo-random number generator based on the Xoroshiro128++ algorithm.

Definition

Namespace: Numerics.NET.Random
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.3.0
C#
public sealed class Xoroshiro128PlusPlus : RandomSource<ScalarGenerator64<Xoroshiro128PlusPlusEngine>>, 
	IRandomSourceFactory<Xoroshiro128PlusPlus>, IAdvanceable, IJumpable
Inheritance
Object  →  RandomSource<ScalarGenerator64<Xoroshiro128PlusPlusEngine>>  →  Xoroshiro128PlusPlus
Implements
IAdvanceable, IJumpable, IRandomSourceFactory<Xoroshiro128PlusPlus>

Remarks

Use the Xoroshiro128PlusPlus class to represent a pseudo-random number generator that uses the Xoroshiro128++ algorithm by David Blackman and Sebastiano Vigna.

This generator has a period of 2128 - 1 and passes all statistical tests. It is faster than the xoshiro256 family but with a smaller state space, making it ideal for applications that need speed but don't require the longest period.

The "++" scrambler provides excellent statistical quality suitable for all purposes except for generating more than 264 random numbers without jumping.

Reference: David Blackman and Sebastiano Vigna. "Scrambled Linear Pseudorandom Number Generators." ACM Trans. Math. Softw. 2021.

Example

C#
var rng = new Xoroshiro128PlusPlus(321);
int n = rng.Next(1, 100);
rng.Jump();

Constructors

Xoroshiro128PlusPlus() Initializes a new instance of the Xoroshiro128PlusPlus class using OS entropy.
Xoroshiro128PlusPlus(RandomOptions) Initializes a new instance of the Xoroshiro128PlusPlus class with the specified options.
Xoroshiro128PlusPlus(ReadOnlySpan<Byte>) Initializes a new instance of the Xoroshiro128PlusPlus class from saved state.
Xoroshiro128PlusPlus(Int64, SeedProfile) Initializes a new instance of the Xoroshiro128PlusPlus class with the specified seed.
Xoroshiro128PlusPlus(ReadOnlySpan<UInt64>, SeedProfile) Initializes a new instance of the Xoroshiro128PlusPlus class with the specified seed array.
Xoroshiro128PlusPlus(UInt64, UInt64) Initializes a new instance of the Xoroshiro128PlusPlus class with direct state initialization.
Xoroshiro128PlusPlus(Int64, StreamAddress, SeedProfile) Initializes a new instance of the Xoroshiro128PlusPlus class with the specified seed.
Xoroshiro128PlusPlus(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile) Initializes a new instance of the Xoroshiro128PlusPlus class with the specified seed array.

Properties

BitsPerWord Gets the number of bits per word in the generator's native output.
(Overrides RandomSource<TGenerator>.BitsPerWord)
JumpSize Gets the size category of the primary jump operation.
LongJumpSize Gets the size category of the long jump operation.
Name Gets a human-readable name for this random number generator.
(Overrides RandomSource<TGenerator>.Name)
StateSize Gets the number of bytes required to save/load this generator's state.
(Inherited from RandomSource<TGenerator>)
Uncached Gets an uncached facade for this random number generator.
(Inherited from RandomSource<TGenerator>)

Methods

Advance Advances the generator state by the specified number of steps.
Copy Creates an exact copy of this generator with the same state.
Create Creates a new Xoroshiro128PlusPlus instance from the specified options.
CreateStreamPartition Creates a jump-based stream partition for generating independent RNG streams.
CreateStreamTree Creates a hierarchical stream tree for generating independent RNG streams.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Fill(Span<UInt32>) Fills a span with random 32-bit unsigned integer values.
(Inherited from RandomSource<TGenerator>)
Fill(Span<Int32>, Int32) Fills a span with random 32-bit signed integers less than the specified maximum.
(Inherited from RandomSource<TGenerator>)
Fill(Span<Int64>, Int64) Fills a span with random 64-bit signed integers less than the specified maximum.
(Inherited from RandomSource<TGenerator>)
Fill(Span<Int32>, Int32, Int32) Fills a span with random 32-bit signed integers within a specified range.
(Inherited from RandomSource<TGenerator>)
Fill(Span<Int64>, Int64, Int64) Fills a span with random 64-bit signed integers within a specified range.
(Inherited from RandomSource<TGenerator>)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetState Returns the current state of the generator as a byte array.
(Inherited from RandomSource<TGenerator>)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Jumped Returns a new instance of the random number generator that is advanced by a specified number of jumps in the sequence.
LoadState Loads the generator's state from the source span in a stable little-endian format.
(Inherited from RandomSource<TGenerator>)
LongJumped Returns a new instance of the random number generator that is advanced by a specified number of long jumps in the sequence.
Next() Returns a non-negative random integer.
(Inherited from RandomSource<TGenerator>)
Next(Int32) Returns a non-negative random integer less than the specified maximum.
(Inherited from RandomSource<TGenerator>)
Next(Int32, Int32) Returns a random integer within a specified range.
(Inherited from RandomSource<TGenerator>)
NextBytes(Byte[]) Fills the elements of a specified array of bytes with random numbers.
(Inherited from RandomSource<TGenerator>)
NextBytes(Span<Byte>) Fills the elements of a specified span of bytes with random numbers.
(Inherited from RandomSource<TGenerator>)
NextBytes(Byte[], Boolean) Fills the elements of a specified span of bytes with random numbers.
(Inherited from RandomSource<TGenerator>)
NextBytes(Span<Byte>, Boolean) Fills the elements of a specified span of bytes with random numbers.
(Inherited from RandomSource<TGenerator>)
NextDouble Returns a random floating-point number in the range [0.0, 1.0).
(Inherited from RandomSource<TGenerator>)
NextInt64() Returns a non-negative random 64-bit integer.
(Inherited from RandomSource<TGenerator>)
NextInt64(Int64) Returns a non-negative random 64-bit integer less than the specified maximum.
(Inherited from RandomSource<TGenerator>)
NextInt64(Int64, Int64) Returns a random 64-bit integer within a specified range.
(Inherited from RandomSource<TGenerator>)
NextSingle Returns a random single-precision floating-point number in the range [0.0, 1.0).
(Inherited from RandomSource<TGenerator>)
NextUInt32 Returns a random 32-bit unsigned integer.
(Inherited from RandomSource<TGenerator>)
NextUInt64 Returns a random 64-bit unsigned integer.
(Inherited from RandomSource<TGenerator>)
Reinitialize Reinitializes this random number generator using the specified initialization options.
(Inherited from RandomSource<TGenerator>)
SaveState Saves the generator's state to the destination span in a stable little-endian format.
(Inherited from RandomSource<TGenerator>)
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also