RandomExtensionsNextSingle(Random, Single, FloatScale) Method

Returns a non-negative random Single 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 float NextSingle(
	this Random random,
	float maxValue,
	FloatScale scale = FloatScale.Auto
)

VB

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

C++

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

F#

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

Parameters

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

Single
A single-precision 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 using very small ranges close to the limits of Single.

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