RandomExtensionsNextBigInteger(Random, BigInteger, BigInteger, Boolean) Method

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

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 7.0.0-rc.1
C#
public static BigInteger NextBigInteger(
	this Random random,
	BigInteger minValue,
	BigInteger maxValue,
	bool inclusiveUpperBound = false
)

Parameters

random  Random
The Random instance to use.
minValue  BigInteger
The inclusive lower bound of the random number returned.
maxValue  BigInteger
The upper bound of the random number returned. Must be greater or equal to minValue.
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 minValue and less or equal to maxValue. If inclusiveUpperBound is , then maxValue is an exclusive upper bound; however, if minValue equals maxValue, maxValue 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

ArgumentNullExceptionrandom is .
ArgumentOutOfRangeExceptionmaxValue is less than minValue.

See Also