RandomExtensionsNextUInt128(Random, UInt128, Boolean) Method

Returns a random 128-bit unsigned integer that is within the specified maximum.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 7.2.0

C#

[CLSCompliantAttribute(false)]
public static UInt128 NextUInt128(
	this Random random,
	UInt128 maxValue,
	bool inclusiveUpperBound = false
)

VB

<ExtensionAttribute>
<CLSCompliantAttribute(false)>
Public Shared Function NextUInt128 ( 
	random As Random,
	maxValue As UInt128,
	Optional inclusiveUpperBound As Boolean = false
) As UInt128

C++

public:
[ExtensionAttribute]
[CLSCompliantAttribute(false)]
static UInt128 NextUInt128(
	Random^ random, 
	UInt128 maxValue, 
	bool inclusiveUpperBound = false
)

F#

[<ExtensionAttribute>]
[<CLSCompliantAttribute(false)>]
static member NextUInt128 : 
        random : Random * 
        maxValue : UInt128 * 
        ?inclusiveUpperBound : bool 
(* Defaults:
        let _inclusiveUpperBound = defaultArg inclusiveUpperBound false
*)
-> UInt128

Parameters

random Random: The Random instance to use.
maxValue UInt128: The upper bound of the random number returned.
inclusiveUpperBound Boolean (Optional): to allow that the generated value is equal to maxValue; otherwise, . This parameter is optional.
Default value: .

Return Value

UInt128
A 128-bit unsigned integer that is greater than or equal to 0 and less than or equal to maxValue. If inclusiveUpperBound is , then maxValue is an exclusive upper bound; however, if maxValue equals 0, then 0 is returned.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Random. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentNullException

random is .