Class RandomExtensions

Namespace

PAC.Extensions.System

Extension methods for Random.

public static class RandomExtensions

Inheritance

object

RandomExtensions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

NextBool(Random)

Generates a uniformly random bool value.

public static bool NextBool(this Random random)

Parameters

random Random

Returns

bool

NextElement<T>(Random, IReadOnlyList<T>)

Selects a uniformly random element from elements.

public static T NextElement<T>(this Random random, IReadOnlyList<T> elements)

Parameters

random Random

elements IReadOnlyList<T>

Returns

T

Type Parameters

T

Exceptions

ArgumentException

elements is empty.

NextFloat(Random)

Returns a random float in the range [0, 1).

public static float NextFloat(this Random random)

Parameters

random Random

Returns

float

ToSequence(Random)

Creates an infinite random sequence, lazily generated using Next().

public static IEnumerable<int> ToSequence(this Random random)

Parameters

random Random

Returns

IEnumerable<int>

Remarks

This does not deep-copy the Random, so calling Next() on this Random between the generation of two elements will affect the sequence. This also means that iterating over the sequence more than once will most likely give a different sequence each time; you may want to 'save' a portion of the sequence using new Random().ToSequence().Take(10).ToArray() or similar.

ToSequence(Random, int, int)

Creates an infinite random sequence, lazily generated using Next(int, int).

public static IEnumerable<int> ToSequence(this Random random, int minValue, int maxValue)

Parameters

random Random

minValue int

The inclusive lower bound of the random numbers generated.

maxValue int

The exclusive upper bound of the random numbers generated. maxValue must be greater than or equal to minValue.

Returns

IEnumerable<int>

Remarks

This does not deep-copy the Random, so calling Next(int, int) on this Random between the generation of two elements will affect the sequence. This also means that iterating over the sequence more than once will most likely give a different sequence each time; you may want to 'save' a portion of the sequence using new Random().ToSequence(minValue, maxValue).Take(10).ToArray() or similar.

Exceptions

ArgumentOutOfRangeException

minValue is greater than maxValue.