RandomOptions Constructor

Definition

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

Overload List

RandomOptions(Int64, StreamAddress, SeedProfile)	Constructs a new RandomOptions with the specified parameters.
RandomOptions(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile)	Constructs a new RandomOptions with a uint[] seed array.
RandomOptions(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile)	Constructs a new RandomOptions with the specified parameters.

RandomOptions(Int64, StreamAddress, SeedProfile)

Constructs a new RandomOptions with the specified parameters.

public RandomOptions(
	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:
RandomOptions(
	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
*)
-> RandomOptions

Parameters

seed Int64: The seed value used for initialization.
streamAddress StreamAddress (Optional): Optional stream address (default: empty).
seedProfile SeedProfile (Optional): The seed profile (default: Default).

Remarks

This constructor does not perform validation. Validation should be performed by calling Validate.

Exceptions

ArgumentOutOfRangeException

seedProfile is not a valid SeedProfile value.

RandomOptions(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile)

Constructs a new RandomOptions with a uint[] seed array.

public RandomOptions(
	ReadOnlySpan<uint> seedArray,
	StreamAddress streamAddress = default,
	SeedProfile seedProfile = SeedProfile.Default
)

Visual Basic

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

C++/CLI

public:
RandomOptions(
	ReadOnlySpan<unsigned int> seedArray, 
	StreamAddress streamAddress = StreamAddress(), 
	SeedProfile seedProfile = SeedProfile::Default
)

new : 
        seedArray : ReadOnlySpan<uint32> * 
        ?streamAddress : StreamAddress * 
        ?seedProfile : SeedProfile 
(* Defaults:
        let _streamAddress = defaultArg streamAddress new StreamAddress()
        let _seedProfile = defaultArg seedProfile SeedProfile.Default
*)
-> RandomOptions

Parameters

seedArray ReadOnlySpan<UInt32>: The 32-bit seed array values.
streamAddress StreamAddress (Optional): Optional stream address (default: empty).
seedProfile SeedProfile (Optional): The seed profile (default: Default).

Remarks

This constructor is primarily used by 32-bit RNGs.

The seed array is used as-is (cloned for immutability).

Exceptions

ArgumentNullException	seedArray is null.
ArgumentOutOfRangeException	seedProfile is not a valid SeedProfile value.

RandomOptions(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile)

Constructs a new RandomOptions with the specified parameters.

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

Visual Basic

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

C++/CLI

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

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

Parameters

seedArray ReadOnlySpan<UInt64>: The seed array values.
streamAddress StreamAddress (Optional): Optional stream address (default: empty).
seedProfile SeedProfile (Optional): The seed profile (default: Default).

Remarks

This constructor does not perform validation. Validation should be performed by calling Validate.

Exceptions

ArgumentNullException	seedArray is null.
ArgumentOutOfRangeException	seedProfile is not a valid SeedProfile value.

RandomOptions Constructor

Definition

Overload List

RandomOptions(Int64, StreamAddress, SeedProfile)

Parameters

Remarks

Exceptions

RandomOptions(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile)

Parameters

Remarks

Exceptions

RandomOptions(ReadOnlySpan<UInt64>, StreamAddress, SeedProfile)

Parameters

Remarks

Exceptions

See Also

Reference