RandomStreams.CreateStreams Method

Definition

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

Overload List

CreateStreams<TRandom>(Int32, RandomOptions, UInt64)	Creates an array of random number generators using mixing-based stream derivation.
CreateStreams<TRandom>(Int32, Int64, UInt64, SeedProfile)	Creates an array of random number generators from a scalar seed.
CreateStreams<TRandom>(Int32, UInt64[], UInt64, SeedProfile)	Creates an array of random number generators from a seed array.

CreateStreams<TRandom>(Int32, RandomOptions, UInt64)

Creates an array of random number generators using mixing-based stream derivation.

public static TRandom[] CreateStreams<TRandom>(
	int count,
	 in RandomOptions options,
	ulong startIndex = 0
)
where TRandom : Object, IRandomSourceFactory<TRandom>

Visual Basic

Public Shared Function CreateStreams(Of TRandom As {Object, IRandomSourceFactory(Of TRandom)}) ( 
	count As Integer,
	 ByRef options As RandomOptions,
	Optional startIndex As ULong = 0
) As TRandom()

C++/CLI

public:
generic<typename TRandom>
where TRandom : Object, IRandomSourceFactory<TRandom>
static array<TRandom>^ CreateStreams(
	int count, 
	[InAttribute]  RandomOptions% options, 
	unsigned long long startIndex = 0
)

static member CreateStreams : 
        count : int * 
         options : RandomOptions byref * 
        ?startIndex : uint64 
(* Defaults:
        let _startIndex = defaultArg startIndex 0
*)
-> 'TRandom[]  when 'TRandom : Object and IRandomSourceFactory<'TRandom>

Parameters

count Int32: The number of generators to create (must be non-negative).
options RandomOptions: The initialization options containing seed and stream address.
startIndex UInt64 (Optional): The starting index for stream enumeration (default is 0).

Type Parameters

TRandom: The type of random number generator to create.

Return Value

TRandom[]
An array of count RNG instances.

Remarks

This method creates streams using mixing-based hierarchical derivation (NumPy-style). Each stream is derived from the base seed material combined with its hierarchical path.

The startIndex parameter allows starting enumeration at a specific offset. For example, startIndex = 5 produces streams at positions [5], [6], [7], etc. relative to the prefix specified in options.

Stream creation is O(1) per stream in the number of streams at the same level, but O(depth) in the hierarchy depth due to path-based derivation.

Example

var options = new RandomOptions(42);
var streams = RandomStreams.CreateStreams<Pcg64>(10, in options, startIndex: 5);
// Produces streams at positions [5], [6], [7], ..., [14]

Exceptions

ArgumentOutOfRangeException

count is negative.

CreateStreams<TRandom>(Int32, Int64, UInt64, SeedProfile)

Creates an array of random number generators from a scalar seed.

public static TRandom[] CreateStreams<TRandom>(
	int count,
	long seed,
	ulong startIndex = 0,
	SeedProfile seedProfile = SeedProfile.Default
)
where TRandom : Object, IRandomSourceFactory<TRandom>

Visual Basic

Public Shared Function CreateStreams(Of TRandom As {Object, IRandomSourceFactory(Of TRandom)}) ( 
	count As Integer,
	seed As Long,
	Optional startIndex As ULong = 0,
	Optional seedProfile As SeedProfile = SeedProfile.Default
) As TRandom()

C++/CLI

public:
generic<typename TRandom>
where TRandom : Object, IRandomSourceFactory<TRandom>
static array<TRandom>^ CreateStreams(
	int count, 
	long long seed, 
	unsigned long long startIndex = 0, 
	SeedProfile seedProfile = SeedProfile::Default
)

static member CreateStreams : 
        count : int * 
        seed : int64 * 
        ?startIndex : uint64 * 
        ?seedProfile : SeedProfile 
(* Defaults:
        let _startIndex = defaultArg startIndex 0
        let _seedProfile = defaultArg seedProfile SeedProfile.Default
*)
-> 'TRandom[]  when 'TRandom : Object and IRandomSourceFactory<'TRandom>

Parameters

count Int32: The number of generators to create (must be non-negative).
seed Int64: The base seed value.
startIndex UInt64 (Optional): The starting index for stream enumeration (default is 0).
seedProfile SeedProfile (Optional): The seed profile to use (default is Default).

Type Parameters

TRandom: The type of random number generator to create.

Return Value

TRandom[]
An array of count RNG instances.

Remarks

This is a convenience overload that constructs RandomOptions from the provided seed and delegates to CreateStreams<TRandom>(Int32, RandomOptions, UInt64).

Example

var streams = RandomStreams.CreateStreams<Pcg64>(10, 42UL, startIndex: 5);

Exceptions

ArgumentOutOfRangeException

count is negative.

CreateStreams<TRandom>(Int32, UInt64[], UInt64, SeedProfile)

Creates an array of random number generators from a seed array.

public static TRandom[] CreateStreams<TRandom>(
	int count,
	ulong[] seedArray,
	ulong startIndex = 0,
	SeedProfile seedProfile = SeedProfile.Default
)
where TRandom : Object, IRandomSourceFactory<TRandom>

Visual Basic

Public Shared Function CreateStreams(Of TRandom As {Object, IRandomSourceFactory(Of TRandom)}) ( 
	count As Integer,
	seedArray As ULong(),
	Optional startIndex As ULong = 0,
	Optional seedProfile As SeedProfile = SeedProfile.Default
) As TRandom()

C++/CLI

public:
generic<typename TRandom>
where TRandom : Object, IRandomSourceFactory<TRandom>
static array<TRandom>^ CreateStreams(
	int count, 
	array<unsigned long long>^ seedArray, 
	unsigned long long startIndex = 0, 
	SeedProfile seedProfile = SeedProfile::Default
)

static member CreateStreams : 
        count : int * 
        seedArray : uint64[] * 
        ?startIndex : uint64 * 
        ?seedProfile : SeedProfile 
(* Defaults:
        let _startIndex = defaultArg startIndex 0
        let _seedProfile = defaultArg seedProfile SeedProfile.Default
*)
-> 'TRandom[]  when 'TRandom : Object and IRandomSourceFactory<'TRandom>

Parameters

count Int32: The number of generators to create (must be non-negative).
seedArray UInt64[]: The base seed array.
startIndex UInt64 (Optional): The starting index for stream enumeration (default is 0).
seedProfile SeedProfile (Optional): The seed profile to use (default is Default).

Type Parameters

TRandom: The type of random number generator to create.

Return Value

TRandom[]
An array of count RNG instances.

Remarks

This is a convenience overload that constructs RandomOptions from the provided seed array and delegates to CreateStreams<TRandom>(Int32, RandomOptions, UInt64).

Example

var seedArray = new ulong[] { 42, 123, 456 };
var streams = RandomStreams.CreateStreams<Pcg64>(10, seedArray, startIndex: 5);

Exceptions

ArgumentOutOfRangeException	count is negative.
ArgumentNullException	seedArray is null.

RandomStreams.CreateStreams Method

Definition

Overload List

CreateStreams<TRandom>(Int32, RandomOptions, UInt64)

Parameters

Type Parameters

Return Value

Remarks

Example

Exceptions

CreateStreams<TRandom>(Int32, Int64, UInt64, SeedProfile)

Parameters

Type Parameters

Return Value

Remarks

Example

Exceptions

CreateStreams<TRandom>(Int32, UInt64[], UInt64, SeedProfile)

Parameters

Type Parameters

Return Value

Remarks

Example

Exceptions

See Also

Reference