WyRand Class

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

Definition

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

Remarks

Use the WyRand class to represent a pseudo-random number generator that uses the WyRand algorithm by Wang Yi.

WyRand is an extremely fast hash-based random number generator with excellent statistical properties. It has a period of approximately 264 and passes all statistical tests including BigCrush and PractRand.

This generator is particularly suitable for simulations, games, and other applications where speed is critical. It is not cryptographically secure.

Reference: Wang Yi. "The fastest strong pseudo random number generator." https://github.com/wangyi-fudan/wyhash

Example

C#
var rng = new WyRand(999);
int randomInt = rng.Next();
double randomDouble = rng.NextDouble();

Constructors

WyRand() Initializes a new instance of the WyRand class using OS entropy.
WyRand(RandomOptions) Initializes a new instance of the WyRand class with the specified options.
WyRand(ReadOnlySpan<Byte>) Initializes a new instance of the WyRand class from saved state.
WyRand(UInt64) Initializes a new instance of the WyRand class with direct state initialization.
WyRand(Int64, SeedProfile) Initializes a new instance of the WyRand class with the specified seed.
WyRand(ReadOnlySpan<UInt64>, SeedProfile) Initializes a new instance of the WyRand class with the specified seed array.
WyRand(Int64, StreamAddress, SeedProfile) Initializes a new instance of the WyRand class with the specified seed.
WyRand(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile) Initializes a new instance of the WyRand 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)
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 RNG state by the specified number of outputs.
Copy Returns a deep copy of this RNG.
Create Creates a new WyRand instance from the specified options.
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)
LoadState Loads the generator's state from the source span in a stable little-endian format.
(Inherited from RandomSource<TGenerator>)
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