Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

OrderablePartitioner(TSource) Class

.NET Framework 4.6 and 4.5

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

System.Object
  System.Collections.Concurrent.Partitioner(TSource)
    System.Collections.Concurrent.OrderablePartitioner(TSource)

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

[<AbstractClass>]
[<HostProtectionAttribute(SecurityAction.LinkDemand, Synchronization = true, 
    ExternalThreading = true)>]
type OrderablePartitioner<'TSource> =  
    class 
        inherit Partitioner<'TSource>
    end

Type Parameters

TSource

Type of the elements in the collection.

The OrderablePartitioner(TSource) type exposes the following members.

  NameDescription
Protected methodSupported by Portable Class LibraryOrderablePartitioner(TSource)Called from constructors in derived classes to initialize the OrderablePartitioner(TSource) class with the specified constraints on the index keys.
Top

  NameDescription
Public propertySupported by Portable Class LibraryKeysNormalizedGets whether order keys are normalized.
Public propertySupported by Portable Class LibraryKeysOrderedAcrossPartitionsGets whether elements in an earlier partition always come before elements in a later partition.
Public propertySupported by Portable Class LibraryKeysOrderedInEachPartitionGets whether elements in each partition are yielded in the order of increasing keys.
Public propertySupported by Portable Class LibrarySupportsDynamicPartitionsGets whether additional partitions can be created dynamically. (Inherited from Partitioner(TSource).)
Top

  NameDescription
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetDynamicPartitionsCreates an object that can partition the underlying collection into a variable number of partitions. (Overrides Partitioner(TSource).GetDynamicPartitions().)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetOrderableDynamicPartitionsCreates an object that can partition the underlying collection into a variable number of partitions.
Public methodSupported by Portable Class LibraryGetOrderablePartitionsPartitions the underlying collection into the specified number of orderable partitions.
Public methodSupported by Portable Class LibraryGetPartitionsPartitions the underlying collection into the given number of ordered partitions. (Overrides Partitioner(TSource).GetPartitions(Int32).)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodSupported by Portable Class LibraryAsParallel(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.)
Public Extension MethodSupported by Portable Class LibraryAsParallel(TSource)()Overloaded. (Defined by ParallelEnumerable.)
Top

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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Synchronization | ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

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.

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4

.NET for Windows Phone apps

Supported in: Windows Phone 8.1

Portable Class Library

Supported in: Portable Class Library

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

Show:
© 2015 Microsoft