ParallelEnumerable.OrderBy<'TSource, 'TKey> Method (ParallelQuery<'TSource>, Func<'TSource, 'TKey>, IComparer<'TKey>)

.NET Framework (current version)
 

Sorts in parallel the elements of a sequence in ascending order by using a specified comparer.

Namespace:   System.Linq
Assembly:  System.Core (in System.Core.dll)

static member OrderBy<'TSource, 'TKey> : 
        source:ParallelQuery<'TSource> *
        keySelector:Func<'TSource, 'TKey> *
        comparer:IComparer<'TKey> -> OrderedParallelQuery<'TSource>

Parameters

source
Type: System.Linq.ParallelQuery<'TSource>

A sequence of values to order.

keySelector
Type: System.Func<'TSource, 'TKey>

A function to extract a key from an element.

comparer
Type: System.Collections.Generic.IComparer<'TKey>

An IComparer{TKey} to compare keys.

Return Value

Type: System.Linq.OrderedParallelQuery<'TSource>

An OrderedParallelQuery{TSource} whose elements are sorted according to a key.

Type Parameters

TSource

The type of elements of source.

TKey

The type of the key returned by keySelector.

Exception Condition
ArgumentNullException

source or keySelector is a null reference (Nothing in Visual Basic).

OperationCanceledException

The query was canceled with the token passed in through WithCancellation.

AggregateException

One or more exceptions occurred during the evaluation of the query.

In contrast to the sequential implementation, this is not a stable sort. See the remarks for OrderBy<'TSource, 'TKey> for an approach to implementing a stable sort.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.0
Portable Class Library
Supported in: portable .NET platforms
Windows Phone
Available since 8.1
Return to top
Show: