PipServices3.Commons.Random.RandomInteger Class Reference

Random generator for integer values. More...

Static Public Member Functions
static int	NextInteger (int maxValue)
	Generates a random integer value in the range to "max". More...
static int	NextInteger (int minValue, int maxValue)
	Generates a random integer value in the range ["min", "max"]. More...
static int	UpdateInteger (int value)
	Updates (drifts) a integer value without specified range defined More...
static int	UpdateInteger (int value, int range)
	Updates (drifts) a integer value within specified range defined More...
static List< int >	Sequence (int size)
	Generates a random sequence of integers starting from 0 like: [0,1,2,3...??] More...
static List< int >	Sequence (int min, int max)
	Generates a random sequence of integers starting from 0 like: [0,1,2,3...??] More...

Static Private Attributes
static readonly System.Random	_random = new System.Random()

Detailed Description

Random generator for integer values.

var value1 = RandomInteger.NextInteger(5, 10);     // Possible result: 7
var value2 = RandomInteger.NextInteger(10);        // Possible result: 3
var value3 = RandomInteger.UpdateInteger(10, 3);   // Possible result: 9

Member Function Documentation

NextInteger() [1/2]

static int PipServices3.Commons.Random.RandomInteger.NextInteger ( int  maxValue )

static

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

Parameters

maxValue

max range value

Returns

a random integer value.

NextInteger() [2/2]

static int PipServices3.Commons.Random.RandomInteger.NextInteger ( int  minValue, int  maxValue  )

static

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

Parameters

minValue	(optional) minimum range value
maxValue	max range value

Returns

a random integer value.

Sequence() [1/2]

static List<int> PipServices3.Commons.Random.RandomInteger.Sequence ( int  size )

static

Generates a random sequence of integers starting from 0 like: [0,1,2,3...??]

Parameters

size	size of sequence

Returns

generated array of integers.

Sequence() [2/2]

static List<int> PipServices3.Commons.Random.RandomInteger.Sequence ( int  min, int  max  )

static

Generates a random sequence of integers starting from 0 like: [0,1,2,3...??]

Parameters

min	minimum value of the integer that will be generated. If 'max' is omitted, then 'max' is set to 'min' and 'min' is set to 0.
max	(optional) maximum value of the integer that will be generated. Defaults to 'min' if omitted.

Returns

generated array of integers.

UpdateInteger() [1/2]

static int PipServices3.Commons.Random.RandomInteger.UpdateInteger ( int  value )

static

Updates (drifts) a integer value without specified range defined

Parameters

value

a integer value to drift.

Returns

updated random integer value.

UpdateInteger() [2/2]

static int PipServices3.Commons.Random.RandomInteger.UpdateInteger ( int  value, int  range  )

static

Updates (drifts) a integer value within specified range defined

Parameters

value	a integer value to drift.
range	(optional) a range. Default: 10% of the value

Returns

updated random integer value.

---

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

• src/Random/RandomInteger.cs