GFSR Class

Represents a pseudo-random number generator based on the Generalized Feedback Shift Register (GFSR) algorithm.

Definition

Namespace: Numerics.NET.Random
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.3.0
C#
public sealed class GFSR : RandomSource<ScalarGenerator32<GfsrEngine>>, 
	IRandomSourceFactory<GFSR>
Inheritance
Object  →  RandomSource<ScalarGenerator32<GfsrEngine>>  →  GFSR
Implements
IRandomSourceFactory<GFSR>

Remarks

Use the GFSR class to represent a pseudo-random number generator that uses a fourth-order generalized feedback shift register algorithm.

This generator has a very long period of 29689 - 1. Thanks to its simplicity, generation is very fast. However, initialization is slow due to the large state size (64 KB).

GFSR generators are linear and fail many modern statistical tests. They are provided primarily for legacy compatibility and historical reproducibility.

For new applications, strongly consider using modern generators like Pcg64, Xoshiro256StarStar, or Xoshiro256Plus which offer far better statistical quality, much smaller state, and similar or better performance.

Reference: Robert M. Ziff. "Four-tap shift-register-sequence random-number generators." Computers in Physics 12(4), Jul/Aug 1998, pp 385-392.

Example

C#
var rng = new Gsfr(12345);
uint value = rng.NextUInt32();
double x = rng.NextDouble();

Constructors

GFSR() Initializes a new instance of the Gsfr class using OS entropy.
GFSR(Int32[]) Initializes a new instance of the Gsfr class with the specified seed array.
GFSR(RandomOptions) Initializes a new instance of the Gsfr class with the specified options.
GFSR(ReadOnlySpan<Byte>) Initializes a new instance of the Gsfr class from saved state.
GFSR(Int64, SeedProfile) Initializes a new instance of the Gsfr class with the specified seed.
GFSR(ReadOnlySpan<UInt32>, SeedProfile) Initializes a new instance of the Gsfr class with the specified seed array.
GFSR(Int64, StreamAddress, SeedProfile) Initializes a new instance of the Gsfr class with the specified seed.
GFSR(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile) Initializes a new instance of the Gsfr 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

Copy Returns a deep copy of this RNG.
Create Creates a new Gsfr 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