RandomExtensionsNextBigInteger(Random, BigInteger, Boolean) Method

Returns a non-negative random BigInteger that is within the specified maximum. To generate a random n-byte integer use the SampleBigInteger method instead.

Definition

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

C#

public static BigInteger NextBigInteger(
	this Random random,
	BigInteger maxValue,
	bool inclusiveUpperBound = false
)

VB

<ExtensionAttribute>
Public Shared Function NextBigInteger ( 
	random As Random,
	maxValue As BigInteger,
	Optional inclusiveUpperBound As Boolean = false
) As BigInteger

C++

public:
[ExtensionAttribute]
static BigInteger NextBigInteger(
	Random^ random, 
	BigInteger maxValue, 
	bool inclusiveUpperBound = false
)

F#

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

Parameters

random Random: The Random instance to use.
maxValue BigInteger: 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

BigInteger
A BigInteger 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 .
ArgumentOutOfRangeException	maxValue is less than 0.