Pip-Services-Commons-Dotnet
Static Public Member Functions | Static Private Attributes | List of all members
PipServices3.Commons.Random.RandomFloat Class Reference

Random generator for float values. More...

Static Public Member Functions

static float NextFloat (int maxValue)
 Generates a random float value in the range to "max". More...
 
static float NextFloat (float minValue, float maxValue)
 Generates a random float value in the range ["min", "max"]. More...
 
static float UpdateFloat (float value)
 Updates (drifts) a float value without specified range defined More...
 
static float UpdateFloat (float value, float range)
 Updates (drifts) a float value within specified range defined More...
 

Static Private Attributes

static readonly System.Random _random = new System.Random()
 

Detailed Description

Random generator for float values.

var value1 = RandomFloat.NextFloat(5, 10); // Possible result: 7.3
var value2 = RandomFloat.NextFloat(10); // Possible result: 3.7
var value3 = RandomFloat.UpdateFloat(10, 3); // Possible result: 9.2

Member Function Documentation

◆ NextFloat() [1/2]

static float PipServices3.Commons.Random.RandomFloat.NextFloat ( int  maxValue)
static

Generates a random float value in the range to "max".

Parameters
maxValuemax range value
Returns
a random float value.

◆ NextFloat() [2/2]

static float PipServices3.Commons.Random.RandomFloat.NextFloat ( float  minValue,
float  maxValue 
)
static

Generates a random float value in the range ["min", "max"].

Parameters
minValue(optional) minimum range value
maxValuemax range value
Returns
a random float value.

◆ UpdateFloat() [1/2]

static float PipServices3.Commons.Random.RandomFloat.UpdateFloat ( float  value)
static

Updates (drifts) a float value without specified range defined

Parameters
valuea float value to drift.
Returns
updated random float value.

◆ UpdateFloat() [2/2]

static float PipServices3.Commons.Random.RandomFloat.UpdateFloat ( float  value,
float  range 
)
static

Updates (drifts) a float value within specified range defined

Parameters
valuea float value to drift.
range(optional) a range. Default: 10% of the value
Returns
updated random float value.

The documentation for this class was generated from the following file: