Xoshiro256StarStar Constructor

Definition

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

Overload List

Xoshiro256StarStar()	Constructs a new Xoshiro256** random number generator with a cryptographically generated seed.
Xoshiro256StarStar(RandomOptions)	Constructs a new Xoshiro256** random number generator with advanced options.
Xoshiro256StarStar(ReadOnlySpan<Byte>)	Constructs a new Xoshiro256** random number generator from saved state.
Xoshiro256StarStar(Int64, SeedProfile)	Constructs a new Xoshiro256** with the specified seed and seed profile.
Xoshiro256StarStar(ReadOnlySpan<UInt64>, SeedProfile)	Constructs a new Xoshiro256** with the specified seed array and seed profile.
Xoshiro256StarStar(Int64, StreamAddress, SeedProfile)	Constructs a new Xoshiro256** random number generator with the specified seed.
Xoshiro256StarStar(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile)	Constructs a new Xoshiro256** random number generator with a seed array.
Xoshiro256StarStar(UInt64, UInt64, UInt64, UInt64)	Initializes a new instance of the Xoshiro256StarStar class with direct state initialization.

Xoshiro256StarStar

Constructs a new Xoshiro256** random number generator with a cryptographically generated seed.

public Xoshiro256StarStar()

Visual Basic

Public Sub New

C++/CLI

public:
Xoshiro256StarStar()

new : unit -> Xoshiro256StarStar

Remarks

This constructor uses the Independent seed profile. It provides a convenient way to create a unique, statistically sound random source without requiring manual seed management.

For large-scale parallel simulations requiring a high degree of coordination between many streams, consider using the explicit streaming methods provided by RandomStreamTree<TRandom> or RandomStreamPartition<TRandom>.

Xoshiro256StarStar(RandomOptions)

Constructs a new Xoshiro256** random number generator with advanced options.

public Xoshiro256StarStar(
	 in RandomOptions options
)

Visual Basic

Public Sub New ( 
	 ByRef options As RandomOptions
)

C++/CLI

public:
Xoshiro256StarStar(
	[InAttribute]  RandomOptions% options
)

new : 
         options : RandomOptions byref -> Xoshiro256StarStar

Parameters

options RandomOptions

Example

var options = new RandomOptions(12345, SeedProfile.Numpy, 0);
var rng = new Xoshiro256StarStar(options);

Xoshiro256StarStar(ReadOnlySpan<Byte>)

Constructs a new Xoshiro256** random number generator from saved state.

public Xoshiro256StarStar(
	ReadOnlySpan<byte> state
)

Visual Basic

Public Sub New ( 
	state As ReadOnlySpan(Of Byte)
)

C++/CLI

public:
Xoshiro256StarStar(
	ReadOnlySpan<unsigned char> state
)

new : 
        state : ReadOnlySpan<byte> -> Xoshiro256StarStar

Parameters

state ReadOnlySpan<Byte>: The saved state to restore.

Remarks

This constructor bypasses initialization and directly loads the state. Use this for exact continuation from a previously saved state.

Example

var rng1 = new Xoshiro256StarStar(42);
rng1.NextUInt64(); // advance state
byte[] state = rng1.GetState();

var rng2 = new Xoshiro256StarStar(state); // exact continuation

Xoshiro256StarStar(Int64, SeedProfile)

Constructs a new Xoshiro256** with the specified seed and seed profile.

public Xoshiro256StarStar(
	long seed,
	SeedProfile seedProfile
)

Visual Basic

Public Sub New ( 
	seed As Long,
	seedProfile As SeedProfile
)

C++/CLI

public:
Xoshiro256StarStar(
	long long seed, 
	SeedProfile seedProfile
)

new : 
        seed : int64 * 
        seedProfile : SeedProfile -> Xoshiro256StarStar

Parameters

seed Int64
seedProfile SeedProfile

Xoshiro256StarStar(ReadOnlySpan<UInt64>, SeedProfile)

Constructs a new Xoshiro256** with the specified seed array and seed profile.

public Xoshiro256StarStar(
	ReadOnlySpan<ulong> seedMaterial,
	SeedProfile seedProfile
)

Visual Basic

Public Sub New ( 
	seedMaterial As ReadOnlySpan(Of ULong),
	seedProfile As SeedProfile
)

C++/CLI

public:
Xoshiro256StarStar(
	ReadOnlySpan<unsigned long long> seedMaterial, 
	SeedProfile seedProfile
)

new : 
        seedMaterial : ReadOnlySpan<uint64> * 
        seedProfile : SeedProfile -> Xoshiro256StarStar

Parameters

seedMaterial ReadOnlySpan<UInt64>
seedProfile SeedProfile

Xoshiro256StarStar(Int64, StreamAddress, SeedProfile)

Constructs a new Xoshiro256** random number generator with the specified seed.

public Xoshiro256StarStar(
	long seed,
	StreamAddress streamAddress = default,
	SeedProfile seedProfile = SeedProfile.Default
)

Visual Basic

Public Sub New ( 
	seed As Long,
	Optional streamAddress As StreamAddress = Nothing,
	Optional seedProfile As SeedProfile = SeedProfile.Default
)

C++/CLI

public:
Xoshiro256StarStar(
	long long seed, 
	StreamAddress streamAddress = StreamAddress(), 
	SeedProfile seedProfile = SeedProfile::Default
)

new : 
        seed : int64 * 
        ?streamAddress : StreamAddress * 
        ?seedProfile : SeedProfile 
(* Defaults:
        let _streamAddress = defaultArg streamAddress new StreamAddress()
        let _seedProfile = defaultArg seedProfile SeedProfile.Default
*)
-> Xoshiro256StarStar

Parameters

seed Int64
streamAddress StreamAddress (Optional)
seedProfile SeedProfile (Optional)

Example

var rng = new Xoshiro256StarStar(123);
int n = rng.Next(100);

Xoshiro256StarStar(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile)

Constructs a new Xoshiro256** random number generator with a seed array.

public Xoshiro256StarStar(
	ReadOnlySpan<ulong> seedMaterial,
	StreamAddress streamAddress = default,
	SeedProfile seedProfile = SeedProfile.Default
)

Visual Basic

Public Sub New ( 
	seedMaterial As ReadOnlySpan(Of ULong),
	Optional streamAddress As StreamAddress = Nothing,
	Optional seedProfile As SeedProfile = SeedProfile.Default
)

C++/CLI

public:
Xoshiro256StarStar(
	ReadOnlySpan<unsigned long long> seedMaterial, 
	StreamAddress streamAddress = StreamAddress(), 
	SeedProfile seedProfile = SeedProfile::Default
)

new : 
        seedMaterial : ReadOnlySpan<uint64> * 
        ?streamAddress : StreamAddress * 
        ?seedProfile : SeedProfile 
(* Defaults:
        let _streamAddress = defaultArg streamAddress new StreamAddress()
        let _seedProfile = defaultArg seedProfile SeedProfile.Default
*)
-> Xoshiro256StarStar

Parameters

seedMaterial ReadOnlySpan<UInt64>
streamAddress StreamAddress (Optional)
seedProfile SeedProfile (Optional)

Xoshiro256StarStar(UInt64, UInt64, UInt64, UInt64)

Initializes a new instance of the Xoshiro256StarStar class with direct state initialization.

public Xoshiro256StarStar(
	ulong s0,
	ulong s1,
	ulong s2,
	ulong s3
)

Visual Basic

Public Sub New ( 
	s0 As ULong,
	s1 As ULong,
	s2 As ULong,
	s3 As ULong
)

C++/CLI

public:
Xoshiro256StarStar(
	unsigned long long s0, 
	unsigned long long s1, 
	unsigned long long s2, 
	unsigned long long s3
)

new : 
        s0 : uint64 * 
        s1 : uint64 * 
        s2 : uint64 * 
        s3 : uint64 -> Xoshiro256StarStar

Parameters

s0 UInt64: First state word.
s1 UInt64: Second state word.
s2 UInt64: Third state word.
s3 UInt64: Fourth state word.

Remarks

This constructor directly sets the four 64-bit state words. The state must not be all zeros.

Exceptions

ArgumentException

All state words are zero.

Xoshiro256StarStar Constructor

Definition

Overload List

Xoshiro256StarStar

Remarks

Xoshiro256StarStar(RandomOptions)

Parameters

Example

Xoshiro256StarStar(ReadOnlySpan<Byte>)

Parameters

Remarks

Example

Xoshiro256StarStar(Int64, SeedProfile)

Parameters

Xoshiro256StarStar(ReadOnlySpan<UInt64>, SeedProfile)

Parameters

Xoshiro256StarStar(Int64, StreamAddress, SeedProfile)

Parameters

Example

Xoshiro256StarStar(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile)

Parameters

Xoshiro256StarStar(UInt64, UInt64, UInt64, UInt64)

Parameters

Remarks

Exceptions

See Also

Reference