CounterBasedGenerator32<TEngine>.GetKey Method

Copies the current key into the provided destination span.

Definition

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

public void GetKey(
	Span<uint> destination
)

Visual Basic

Public Sub GetKey ( 
	destination As Span(Of UInteger)
)

C++/CLI

public:
virtual void GetKey(
	Span<unsigned int> destination
) sealed

abstract GetKey : 
        destination : Span<uint32> -> unit 
override GetKey : 
        destination : Span<uint32> -> unit

Parameters

destination Span<UInt32>: The destination span that will receive the key words. Its length must exactly match the engine's key length.

Implements

ICounterBased<T>.GetKey(Span<T>)

Remarks

Implementations must copy the key words into destination. This avoids returning spans that reference engine-owned storage which could become invalid when called through boxed structs.

Exceptions

ArgumentException

Thrown when destination.Length != the engine key length.