Pcg32 Class

Represents a pseudo-random number generator based on the PCG32 XSH-RR algorithm.

Definition

Namespace: Numerics.NET.Random
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 10.7.0
C#
public sealed class Pcg32 : RandomSource<ScalarGenerator32<Pcg32Engine>>, 
	IRandomSourceFactory<Pcg32>, IAdvanceable, IJumpable
Inheritance
Object  →  RandomSource<ScalarGenerator32<Pcg32Engine>>  →  Pcg32
Implements
IAdvanceable, IJumpable, IRandomSourceFactory<Pcg32>

Remarks

Use the Pcg32 class to represent a pseudo-random number generator that uses the PCG32 XSH-RR (Xorshift-High, Random-Rotate) algorithm by Melissa O'Neill.

This generator features a 64-bit state with a period of 264. The algorithm is very fast and produces very good random sequences. Moreover, it is possible to run several sequences in parallel.

Pcg32 can be used in place of the Random class to obtain pseudo-random numbers of a higher quality.

Note: This generator uses the new Layer 3 architecture with ScalarGenerator32<TEngine> for optimal performance.

Constructors

Pcg32() Initializes a new instance of the Pcg32 class using OS entropy.
Pcg32(RandomOptions) Initializes a new instance of the Pcg32 class with the specified options.
Pcg32(ReadOnlySpan<Byte>) Initializes a new instance of the Pcg32 class from saved state.
Pcg32(Int64, SeedProfile) Initializes a new instance of the Pcg32 class with the specified seed.
Pcg32(ReadOnlySpan<UInt32>, SeedProfile) Initializes a new instance of the Pcg32 class with the specified seed array.
Pcg32(UInt64, UInt64) Initializes a new instance of the Pcg32 class with direct state and stream initialization.
Pcg32(Int64, StreamAddress, SeedProfile) Initializes a new instance of the Pcg32 class with the specified seed.
Pcg32(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile) Initializes a new instance of the Pcg32 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 forward by a specified number of steps.
Copy Creates a copy of this random number generator with the same state.
Create Creates a new Pcg32 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>)
LongJump Jumps ahead in the random sequence by an even larger fixed amount.
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>)
NextBounded Returns a random unsigned integer less than the specified value.
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>)
Skip Skips ahead by the specified number of steps.
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also