ParallelHelperBeginSortTKeyFrom, TKeyTo, TValueFrom, TValueTo(CastArrayTKeyFrom, TKeyTo, CastArrayTValueFrom, TValueTo, IComparerTKeyTo, AsyncConfig) 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 IAsyncResult BeginSort<TKeyFrom, TKeyTo, TValueFrom, TValueTo>(
	CastArray<TKeyFrom, TKeyTo> keys,
	CastArray<TValueFrom, TValueTo> values,
	IComparer<TKeyTo>? comparer = null,
	AsyncConfig? asyncConfig = null
)
where TKeyFrom : struct, new()
where TKeyTo : struct, new()
where TValueFrom : struct, new()
where TValueTo : struct, new()

Public Shared Function BeginSort(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 AsyncConfig = Nothing
) As IAsyncResult

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 IAsyncResult^ BeginSort(
	CastArray<TKeyFrom, TKeyTo> keys, 
	CastArray<TValueFrom, TValueTo> values, 
	IComparer<TKeyTo>^ comparer = nullptr, 
	AsyncConfig^ asyncConfig = nullptr
)

static member BeginSort : 
        keys : CastArray<'TKeyFrom, 'TKeyTo> * 
        values : CastArray<'TValueFrom, 'TValueTo> * 
        ?comparer : IComparer<'TKeyTo> * 
        ?asyncConfig : AsyncConfig 
(* Defaults:
        let _comparer = defaultArg comparer null
        let _asyncConfig = defaultArg asyncConfig null
*)
-> IAsyncResult  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 AsyncConfig (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

IAsyncResult
An IAsyncResult that represents the asynchronous operation, which could still be pending.

Remarks

In .NET Framework 4.0 and above you can use also the SortAsync methods.

To get the result or the exception that occurred during the operation you have to call the EndSort method.

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.