RandomStreamSource<TRandom>.Branch Method

Creates a child stream source at the specified index without advancing this source.

Definition

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

public IRandomStreamSource<TRandom> Branch(
	ulong index
)

Visual Basic

Public Function Branch ( 
	index As ULong
) As IRandomStreamSource(Of TRandom)

C++/CLI

public:
virtual IRandomStreamSource<TRandom>^ Branch(
	unsigned long long index
) sealed

abstract Branch : 
        index : uint64 -> IRandomStreamSource<'TRandom> 
override Branch : 
        index : uint64 -> IRandomStreamSource<'TRandom>

Parameters

index UInt64: The child index for the new scope.

Return Value

IRandomStreamSource<TRandom>
A new stream source with path Path + [index] and NextIndex = 0.

Implements

IRandomStreamSource<TRandom>.Branch(UInt64)

Remarks

This method creates a child scope without consuming the parent's next index. The parent's NextIndex remains unchanged.

Use this method when you need to create streams at specific indices in the hierarchy, such as for deterministic parallel workload distribution.