This documentation is archived and is not being maintained.

Partitioner<TSource> Class

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

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

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

Type Parameters

TSource

Type of the elements in the collection.

The Partitioner<TSource> type exposes the following members.

  NameDescription
Protected methodPartitioner<TSource>Creates a new partitioner instance.
Top

  NameDescription
Public propertySupportsDynamicPartitionsGets whether additional partitions can be created dynamically.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetDynamicPartitionsCreates an object that can partition the underlying collection into a variable number of partitions.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetPartitionsPartitions the underlying collection into the given number of partitions.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public Extension MethodAsParallel<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

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 a partitioner that returns a single element at a time:

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

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

The static methods on Partitioner<TSource> are all thread-safe and may be used concurrently from multiple threads. However, while a created partitioner is in use, the underlying data source should not be modified, whether from the same thread that is using a partitioner or from a separate thread.

Show: