OrderablePartitioner(TSource) Class

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:   System.Collections.Concurrent (in System.Collections.Concurrent.dll)
  mscorlib (in mscorlib.dll)

[<AbstractClass>]
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 LibrarySupported in .NET for Windows Store appsOrderablePartitioner(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 LibrarySupported in .NET for Windows Store appsKeysNormalizedGets whether order keys are normalized.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsKeysOrderedAcrossPartitionsGets whether elements in an earlier partition always come before elements in a later partition.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsKeysOrderedInEachPartitionGets whether elements in each partition are yielded in the order of increasing keys.
Public propertySupported by Portable Class LibrarySupported in .NET for Windows Store appsSupportsDynamicPartitionsGets whether additional partitions can be created dynamically. (Inherited from Partitioner(TSource).)
Top

  NameDescription
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsFinalizeAllows 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 LibrarySupported in .NET for Windows Store appsGetDynamicPartitionsCreates an object that can partition the underlying collection into a variable number of partitions. (Overrides Partitioner(TSource).GetDynamicPartitions().)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetOrderableDynamicPartitionsCreates an object that can partition the underlying collection into a variable number of partitions.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetOrderablePartitionsPartitions the underlying collection into the specified number of orderable partitions.
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetPartitionsPartitions the underlying collection into the given number of ordered partitions. (Overrides Partitioner(TSource).GetPartitions(Int32).)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Portable Class LibrarySupported in .NET for Windows Store appsToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodSupported by Portable Class LibrarySupported in .NET for Windows Store appsAsParallel(TSource)Enables parallelization of a query, as sourced by a custom partitioner that is responsible for splitting the input sequence into partitions. (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.

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.5.3, 4

.NET Framework Client Profile

Supported in: 4

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Windows Phone 8.1, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft