ChaCha Constructor

Definition

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

Overload List

ChaCha()	Initializes a new instance of the ChaCha class using OS entropy.
ChaCha(RandomOptions)	Initializes a new instance of the ChaCha class with the specified options.
ChaCha(ReadOnlySpan<Byte>)	Initializes a new instance of the ChaCha class from saved state.
ChaCha(Int64, ChaChaVariant)	Constructs a new ChaCha random number generator with the specified seed and variant.
ChaCha(Int64, SeedProfile)	Initializes a new instance of the ChaCha class with the specified seed.
ChaCha(ReadOnlySpan<UInt32>, SeedProfile)	Initializes a new instance of the ChaCha class with the specified seed array.
ChaCha(ReadOnlySpan<UInt64>, ChaChaVariant)	Constructs a new ChaCha random number generator with the specified seed and variant.
ChaCha(Int64, StreamAddress, ChaChaVariant)	Constructs a new ChaCha random number generator with the specified seed, stream ID, and variant.
ChaCha(Int64, StreamAddress, SeedProfile)	Initializes a new instance of the ChaCha class with the specified seed.
ChaCha(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile)	Initializes a new instance of the ChaCha class with the specified seed array.

ChaCha

Initializes a new instance of the ChaCha class using OS entropy.

public ChaCha()

Visual Basic

Public Sub New

C++/CLI

public:
ChaCha()

new : unit -> ChaCha

ChaCha(RandomOptions)

Initializes a new instance of the ChaCha class with the specified options.

public ChaCha(
	RandomOptions options
)

Visual Basic

Public Sub New ( 
	options As RandomOptions
)

C++/CLI

public:
ChaCha(
	RandomOptions options
)

new : 
        options : RandomOptions -> ChaCha

Parameters

options RandomOptions: The initialization options containing seed, stream ID, and seed profile.

ChaCha(ReadOnlySpan<Byte>)

Initializes a new instance of the ChaCha class from saved state.

public ChaCha(
	ReadOnlySpan<byte> state
)

Visual Basic

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

C++/CLI

public:
ChaCha(
	ReadOnlySpan<unsigned char> state
)

new : 
        state : ReadOnlySpan<byte> -> ChaCha

Parameters

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

Exceptions

ArgumentException

The length of state is less than the required state size.

ChaCha(Int64, ChaChaVariant)

Constructs a new ChaCha random number generator with the specified seed and variant.

public ChaCha(
	long seed,
	ChaChaVariant variant
)

Visual Basic

Public Sub New ( 
	seed As Long,
	variant As ChaChaVariant
)

C++/CLI

public:
ChaCha(
	long long seed, 
	ChaChaVariant variant
)

new : 
        seed : int64 * 
        variant : ChaChaVariant -> ChaCha

Parameters

seed Int64: The initial seed of the generator.
variant ChaChaVariant: The ChaCha variant.

Remarks

This constructor uses the SplitMix64 seeding algorithm and Generic stream mode.

Variant mapping:

ChaCha20: 20 rounds (default)
ChaCha12: 12 rounds
ChaCha8: 8 rounds

Example

var rng = new ChaCha20(54321, ChaChaVariant.ChaCha8);

Exceptions

ArgumentOutOfRangeException

Thrown when variant is not a valid ChaChaVariant value.

ChaCha(Int64, SeedProfile)

Initializes a new instance of the ChaCha class with the specified seed.

public ChaCha(
	long seed,
	SeedProfile seedProfile = SeedProfile.Default
)

Visual Basic

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

C++/CLI

public:
ChaCha(
	long long seed, 
	SeedProfile seedProfile = SeedProfile::Default
)

new : 
        seed : int64 * 
        ?seedProfile : SeedProfile 
(* Defaults:
        let _seedProfile = defaultArg seedProfile SeedProfile.Default
*)
-> ChaCha

Parameters

seed Int64: A number used to calculate a starting value for the pseudo-random number sequence.
seedProfile SeedProfile (Optional): The seed profile to use for initialization.

ChaCha(ReadOnlySpan<UInt32>, SeedProfile)

Initializes a new instance of the ChaCha class with the specified seed array.

public ChaCha(
	ReadOnlySpan<uint> seedMaterial,
	SeedProfile seedProfile = SeedProfile.Default
)

Visual Basic

Public Sub New ( 
	seedMaterial As ReadOnlySpan(Of UInteger),
	Optional seedProfile As SeedProfile = SeedProfile.Default
)

C++/CLI

public:
ChaCha(
	ReadOnlySpan<unsigned int> seedMaterial, 
	SeedProfile seedProfile = SeedProfile::Default
)

new : 
        seedMaterial : ReadOnlySpan<uint32> * 
        ?seedProfile : SeedProfile 
(* Defaults:
        let _seedProfile = defaultArg seedProfile SeedProfile.Default
*)
-> ChaCha

Parameters

seedMaterial ReadOnlySpan<UInt32>: An array of numbers used to calculate a starting value for the pseudo-random number sequence.
seedProfile SeedProfile (Optional): The seed profile to use for initialization.

Exceptions

ArgumentNullException

seedMaterial is null.

ChaCha(ReadOnlySpan<UInt64>, ChaChaVariant)

Constructs a new ChaCha random number generator with the specified seed and variant.

public ChaCha(
	ReadOnlySpan<ulong> seedArray,
	ChaChaVariant variant
)

Visual Basic

Public Sub New ( 
	seedArray As ReadOnlySpan(Of ULong),
	variant As ChaChaVariant
)

C++/CLI

public:
ChaCha(
	ReadOnlySpan<unsigned long long> seedArray, 
	ChaChaVariant variant
)

new : 
        seedArray : ReadOnlySpan<uint64> * 
        variant : ChaChaVariant -> ChaCha

Parameters

seedArray ReadOnlySpan<UInt64>: The seed array values.
variant ChaChaVariant: The ChaCha variant.

Remarks

This constructor uses the SplitMix64 seeding algorithm and Generic stream mode.

Variant mapping:

ChaCha20: 20 rounds (default)
ChaCha12: 12 rounds
ChaCha8: 8 rounds

Exceptions

ArgumentOutOfRangeException

Thrown when variant is not a valid ChaChaVariant value.

ChaCha(Int64, StreamAddress, ChaChaVariant)

Constructs a new ChaCha random number generator with the specified seed, stream ID, and variant.

public ChaCha(
	long seed,
	StreamAddress streamAddress,
	ChaChaVariant variant
)

Visual Basic

Public Sub New ( 
	seed As Long,
	streamAddress As StreamAddress,
	variant As ChaChaVariant
)

C++/CLI

public:
ChaCha(
	long long seed, 
	StreamAddress streamAddress, 
	ChaChaVariant variant
)

new : 
        seed : int64 * 
        streamAddress : StreamAddress * 
        variant : ChaChaVariant -> ChaCha

Parameters

seed Int64: The initial seed of the generator.
streamAddress StreamAddress: Optional stream identifier for stream selection.
variant ChaChaVariant: The ChaCha variant.

Remarks

This constructor uses the SplitMix64 seeding algorithm.

Variant mapping:

ChaCha20: 20 rounds (default)
ChaCha12: 12 rounds
ChaCha8: 8 rounds

Exceptions

ArgumentOutOfRangeException

Thrown when variant is not a valid ChaChaVariant value.

ChaCha(Int64, StreamAddress, SeedProfile)

Initializes a new instance of the ChaCha class with the specified seed.

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

Visual Basic

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

C++/CLI

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

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

Parameters

seed Int64: A number used to calculate a starting value for the pseudo-random number sequence.
streamAddress StreamAddress: Optional stream identifier for stream selection.
seedProfile SeedProfile (Optional): The seed profile to use for initialization.

ChaCha(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile)

Initializes a new instance of the ChaCha class with the specified seed array.

public ChaCha(
	ReadOnlySpan<uint> seedMaterial,
	StreamAddress streamAddress,
	SeedProfile seedProfile = SeedProfile.Default
)

Visual Basic

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

C++/CLI

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

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

Parameters

seedMaterial ReadOnlySpan<UInt32>: An array of numbers used to calculate a starting value for the pseudo-random number sequence.
streamAddress StreamAddress: Optional stream address for stream selection.
seedProfile SeedProfile (Optional): The seed profile to use for initialization.

Exceptions

ArgumentNullException

seedMaterial is null.

ChaCha Constructor

Definition

Overload List

ChaCha

ChaCha(RandomOptions)

Parameters

ChaCha(ReadOnlySpan<Byte>)

Parameters

Exceptions

ChaCha(Int64, ChaChaVariant)

Parameters

Remarks

Example

Exceptions

ChaCha(Int64, SeedProfile)

Parameters

ChaCha(ReadOnlySpan<UInt32>, SeedProfile)

Parameters

Exceptions

ChaCha(ReadOnlySpan<UInt64>, ChaChaVariant)

Parameters

Remarks

Exceptions

ChaCha(Int64, StreamAddress, ChaChaVariant)

Parameters

Remarks

Exceptions

ChaCha(Int64, StreamAddress, SeedProfile)

Parameters

ChaCha(ReadOnlySpan<UInt32>, StreamAddress, SeedProfile)

Parameters

Exceptions

See Also

Reference