EnumerableExtensions.Shuffle(T) Method (IEnumerable(T))


EnumerableExtensionsShuffleT Method (IEnumerableT)	KGy SOFT Core Libraries Help

Shuffles an enumerable source (randomizes its elements) using a new FastRandom instance.

Namespace: KGySoft.CoreLibraries
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 7.0.0-preview.3

Syntax

public static IEnumerable<T> Shuffle<T>(
	this IEnumerable<T> source
)

<ExtensionAttribute>
Public Shared Function Shuffle(Of T) ( 
	source As IEnumerable(Of T)
) As IEnumerable(Of T)

public:
[ExtensionAttribute]
generic<typename T>
static IEnumerable<T>^ Shuffle(
	IEnumerable<T>^ source
)

[<ExtensionAttribute>]
static member Shuffle : 
        source : IEnumerable<'T> -> IEnumerable<'T>

source: Type: System.Collections.GenericIEnumerableT
The IEnumerableT to shuffle its elements.

Type: IEnumerableT
An IEnumerableT that can enumerate the items of source in a randomized order.

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

Remarks

Note
Subsequent enumerations of the returned collection shuffles the order of the items again an again.

Note
The enumerator of the returned collection does not support the IEnumerator.Reset method.