Xoshiro256PlusPlus Class

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

Definition

Namespace: Numerics.NET.Random
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.3.0

public sealed class Xoshiro256PlusPlus : RandomSource<ScalarGenerator64<Xoshiro256PlusPlusEngine>>, 
	IRandomSourceFactory<Xoshiro256PlusPlus>, IAdvanceable, IJumpable

Visual Basic

Public NotInheritable Class Xoshiro256PlusPlus
	Inherits RandomSource(Of ScalarGenerator64(Of Xoshiro256PlusPlusEngine))
	Implements IRandomSourceFactory(Of Xoshiro256PlusPlus), IAdvanceable, 
	IJumpable

C++/CLI

public ref class Xoshiro256PlusPlus sealed : public RandomSource<ScalarGenerator64<Xoshiro256PlusPlusEngine>>, 
	IRandomSourceFactory<Xoshiro256PlusPlus^>, IAdvanceable, IJumpable

[<SealedAttribute>]
type Xoshiro256PlusPlus = 
    class
        inherit RandomSource<ScalarGenerator64<Xoshiro256PlusPlusEngine>>
        interface IRandomSourceFactory<Xoshiro256PlusPlus>
        interface IAdvanceable
        interface IJumpable
    end

Inheritance: Object → RandomSource<ScalarGenerator64<Xoshiro256PlusPlusEngine>> → Xoshiro256PlusPlus

Implements: IAdvanceable, IJumpable, IRandomSourceFactory<Xoshiro256PlusPlus>

Remarks

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

This generator has a period of 2²⁵⁶ - 1 and passes all statistical tests. It is one of the fastest high-quality generators and is the default in many modern systems.

The "++" scrambler provides excellent statistical properties for all use cases, combining the benefits of both Xoshiro256StarStar and Xoshiro256Plus.

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

Example

var rng = new Xoshiro256PlusPlus(789);
ulong value = rng.NextUInt64();
rng.LongJump();

Constructors

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

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 Xoshiro256PlusPlus 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.
Equals	Determines 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>)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetState	Returns the current state of the generator as a byte array. (Inherited from RandomSource<TGenerator>)
GetType	Gets 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>)
ToString	Returns a string that represents the current object. (Inherited from Object)