ParallelHelperSortAsyncTKeyFrom, TKeyTo, TValueFrom, TValueTo(CastArrayTKeyFrom, TKeyTo, CastArrayTValueFrom, TValueTo, IComparerTKeyTo, TaskConfig) Method

Sorts the elements in a pair of CastArrayTFrom, TTo instances asynchronously (one contains the keys, the other contains the corresponding values), potentially using multiple threads.

Definition

Namespace: KGySoft.Threading
Assembly: KGySoft.CoreLibraries (in KGySoft.CoreLibraries.dll) Version: 10.5.0

public static Task<bool> SortAsync<TKeyFrom, TKeyTo, TValueFrom, TValueTo>(
	CastArray<TKeyFrom, TKeyTo> keys,
	CastArray<TValueFrom, TValueTo> values,
	IComparer<TKeyTo>? comparer = null,
	TaskConfig? asyncConfig = null
)
where TKeyFrom : struct, new()
where TKeyTo : struct, new()
where TValueFrom : struct, new()
where TValueTo : struct, new()

Public Shared Function SortAsync(Of TKeyFrom As {Structure, New}, TKeyTo As {Structure, New}, TValueFrom As {Structure, New}, TValueTo As {Structure, New}) ( 
	keys As CastArray(Of TKeyFrom, TKeyTo),
	values As CastArray(Of TValueFrom, TValueTo),
	Optional comparer As IComparer(Of TKeyTo) = Nothing,
	Optional asyncConfig As TaskConfig = Nothing
) As Task(Of Boolean)

C++

public:
generic<typename TKeyFrom, typename TKeyTo, typename TValueFrom, typename TValueTo>
where TKeyFrom : value class, gcnew()
where TKeyTo : value class, gcnew()
where TValueFrom : value class, gcnew()
where TValueTo : value class, gcnew()
static Task<bool>^ SortAsync(
	CastArray<TKeyFrom, TKeyTo> keys, 
	CastArray<TValueFrom, TValueTo> values, 
	IComparer<TKeyTo>^ comparer = nullptr, 
	TaskConfig^ asyncConfig = nullptr
)

static member SortAsync : 
        keys : CastArray<'TKeyFrom, 'TKeyTo> * 
        values : CastArray<'TValueFrom, 'TValueTo> * 
        ?comparer : IComparer<'TKeyTo> * 
        ?asyncConfig : TaskConfig 
(* Defaults:
        let _comparer = defaultArg comparer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> Task<bool>  when 'TKeyFrom : struct, new() when 'TKeyTo : struct, new() when 'TValueFrom : struct, new() when 'TValueTo : struct, new()

Parameters

keys CastArrayTKeyFrom, TKeyTo: The CastArrayTFrom, TTo that contains the keys to sort.
values CastArrayTValueFrom, TValueTo: The CastArrayTFrom, TTo that contains the values that correspond to the keys in the keys collection. If the IsNull property of values is , then only the keys are sorted.
comparer IComparerTKeyTo (Optional): The IComparerT implementation to use when comparing elements, or to use a default comparer. This parameter is optional.
Default value: .
asyncConfig TaskConfig (Optional): An optional configuration to adjust parallelization or cancellation. Reporting progress is not supported in sorting methods. This parameter is optional.
Default value: .

Type Parameters

TKeyFrom: The actual element type of the underlying array in keys.
TKeyTo: The reinterpreted element type of the CastArrayTFrom, TTo instance in keys.
TValueFrom: The actual element type of the underlying array in values.
TValueTo: The reinterpreted element type of the CastArrayTFrom, TTo instance in values.

Return Value

TaskBoolean
A task that represents the asynchronous operation. Its result is , if the operation completed successfully, or , if the operation has been canceled and ThrowIfCanceled in asyncConfig parameter was .

Remarks

This method is not a blocking call even if the MaxDegreeOfParallelism property of the asyncConfig parameter is 1.

Exceptions

ArgumentException	The IsNull property of values is and values has fewer elements than keys. -or- The comparer returned inconsistent results.
InvalidOperationException	comparer is , and an element does not implement the IComparableT interface.
TaskCanceledException	The operation has been canceled and ThrowIfCanceled in asyncConfig was . This exception is thrown when the result is awaited.