OrderablePartitioner<TSource> Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Represents a particular manner of splitting an orderable data source into multiple partitions.

Namespace:   System.Collections.Concurrent
Assembly:  mscorlib (in mscorlib.dll)

System::Object
  System.Collections.Concurrent::Partitioner<TSource>
    System.Collections.Concurrent::OrderablePartitioner<TSource>

generic<typename TSource>
[HostProtectionAttribute(SecurityAction::LinkDemand, Synchronization = true, 
	ExternalThreading = true)]
public ref class OrderablePartitioner abstract : Partitioner<TSource>

Type Parameters

TSource

Type of the elements in the collection.

NameDescription
System_CAPS_protmethodOrderablePartitioner<TSource>(Boolean, Boolean, Boolean)

Called from constructors in derived classes to initialize the OrderablePartitioner<TSource> class with the specified constraints on the index keys.

NameDescription
System_CAPS_pubpropertyKeysNormalized

Gets whether order keys are normalized.

System_CAPS_pubpropertyKeysOrderedAcrossPartitions

Gets whether elements in an earlier partition always come before elements in a later partition.

System_CAPS_pubpropertyKeysOrderedInEachPartition

Gets whether elements in each partition are yielded in the order of increasing keys.

System_CAPS_pubpropertySupportsDynamicPartitions

Gets whether additional partitions can be created dynamically.(Inherited from Partitioner<TSource>.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetDynamicPartitions()

Creates an object that can partition the underlying collection into a variable number of partitions.(Overrides Partitioner<TSource>::GetDynamicPartitions().)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetOrderableDynamicPartitions()

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

System_CAPS_pubmethodGetOrderablePartitions(Int32)

Partitions the underlying collection into the specified number of orderable partitions.

System_CAPS_pubmethodGetPartitions(Int32)

Partitions the underlying collection into the given number of ordered partitions.(Overrides Partitioner<TSource>::GetPartitions(Int32).)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubmethodAsParallel<TSource>()

Overloaded. Enables parallelization of a query, as sourced by a custom partitioner that is responsible for splitting the input sequence into partitions.(Defined by ParallelEnumerable.)

The implementation of the derived class is responsible for ordering the elements into key-value pairs in whatever manner is appropriate. For more information, see Custom Partitioners for PLINQ and TPL.

The following example shows how to implement an orderable partitioner that returns one element at a time:

No code example is currently available or this language may not be supported.

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

All public members of OrderablePartitioner<TSource> are thread-safe and may be called from multiple threads concurrently.

Return to top
Show: