OrderablePartitioner<TSource>.GetOrderableDynamicPartitions Method

Definition

Creates an object that can partition the underlying collection into a variable number of partitions.

public:
 virtual System::Collections::Generic::IEnumerable<System::Collections::Generic::KeyValuePair<long, TSource>> ^ GetOrderableDynamicPartitions();
public virtual System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<long,TSource>> GetOrderableDynamicPartitions ();
abstract member GetOrderableDynamicPartitions : unit -> seq<System.Collections.Generic.KeyValuePair<int64, 'Source>>
override this.GetOrderableDynamicPartitions : unit -> seq<System.Collections.Generic.KeyValuePair<int64, 'Source>>
Public Overridable Function GetOrderableDynamicPartitions () As IEnumerable(Of KeyValuePair(Of Long, TSource))

Returns

IEnumerable<KeyValuePair<Int64,TSource>>

An object that can create partitions over the underlying data source.

Exceptions

Dynamic partitioning is not supported by this partitioner.

Remarks

The returned object implements the System.Collections.Generic.IEnumerable<T> interface. Calling GetEnumerator on the object creates another partition over the sequence.

Each partition is represented as an enumerator over key-value pairs. The value in the pair is the element itself, and the key is an integer which determines the relative ordering of this element against other elements.

The GetOrderableDynamicPartitions method is only supported if the SupportsDynamicPartitions property returns true.

For more information, see Custom Partitioners for PLINQ and TPL.

Applies to

See also