RandomExtensionsNextDecimal(Random, Decimal, FloatScale) Method

Returns a non-negative random Decimal value that is less than or equal to the specified maxValue.

Definition

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

C#

public static decimal NextDecimal(
	this Random random,
	decimal maxValue,
	FloatScale scale = FloatScale.Auto
)

VB

<ExtensionAttribute>
Public Shared Function NextDecimal ( 
	random As Random,
	maxValue As Decimal,
	Optional scale As FloatScale = FloatScale.Auto
) As Decimal

C++

public:
[ExtensionAttribute]
static Decimal NextDecimal(
	Random^ random, 
	Decimal maxValue, 
	FloatScale scale = FloatScale::Auto
)

F#

[<ExtensionAttribute>]
static member NextDecimal : 
        random : Random * 
        maxValue : decimal * 
        ?scale : FloatScale 
(* Defaults:
        let _scale = defaultArg scale FloatScale.Auto
*)
-> decimal

Parameters

random Random: The Random instance to use.
maxValue Decimal: The upper bound of the random number returned.
scale FloatScale (Optional): The scale to use to generate the random number. This parameter is optional.
Default value: Auto.

Return Value

Decimal
A decimal floating point number that is greater than or equal to 0.0 and less than or equal to maxValue.

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).

Remarks

In most cases return value is less than maxValue. Return value can be equal to maxValue in very edge cases, such as when maxValue is near Epsilon.

If scale is Auto, then the ForceLinear option is used if maxValue is less than or equal to 65535. For larger range the ForceLogarithmic option is used.

Generating random numbers by this method on the logarithmic scale is about 25-50 times slower than on the linear scale.

Exceptions

ArgumentNullException	random is .
ArgumentOutOfRangeException	maxValue is less than 0.0 -or- scale is not a valid value of FloatScale.