EnumerableExtensionsGetRandomElementT(IEnumerableT, Random, Boolean) Method

Gets a random element from the enumerable source using a specified Random instance.

Definition

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 9.0.0
C#
public static T GetRandomElement<T>(
	this IEnumerable<T> source,
	Random random,
	bool defaultIfEmpty = false
)

Parameters

source  IEnumerableT
The IEnumerableT to select an element from.
random  Random
The Random instance to use.
defaultIfEmpty  Boolean  (Optional)
If and source is empty, the default value of T is returned. If , and source is empty, an ArgumentException will be thrown. This parameter is optional.
Default value: .

Type Parameters

T
The type of the elements of source.

Return Value

T
A random element from the source.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableT. 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).

Exceptions

ArgumentNullExceptionrandom or source is .
ArgumentExceptionsource contains no elements and defaultIfEmpty is .

See Also