Partitioner.Create Method

Definition

Creates a partitioner.

Overloads

Create(Int32, Int32)

Creates a partitioner that chunks the user-specified range.

Create(Int64, Int64)

Creates a partitioner that chunks the user-specified range.

Create(Int32, Int32, Int32)

Creates a partitioner that chunks the user-specified range.

Create(Int64, Int64, Int64)

Creates a partitioner that chunks the user-specified range.

Create<TSource>(IEnumerable<TSource>)

Creates an orderable partitioner from a IEnumerable<T> instance.

Create<TSource>(IEnumerable<TSource>, EnumerablePartitionerOptions)

Creates an orderable partitioner from a IEnumerable<T> instance.

Create<TSource>(IList<TSource>, Boolean)

Creates an orderable partitioner from an IList<T> instance.

Create<TSource>(TSource[], Boolean)

Creates an orderable partitioner from a Array instance.

Create(Int32, Int32)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates a partitioner that chunks the user-specified range.

public:
 static System::Collections::Concurrent::OrderablePartitioner<Tuple<int, int> ^> ^ Create(int fromInclusive, int toExclusive);
public static System.Collections.Concurrent.OrderablePartitioner<Tuple<int,int>> Create (int fromInclusive, int toExclusive);
static member Create : int * int -> System.Collections.Concurrent.OrderablePartitioner<int * int>
Public Shared Function Create (fromInclusive As Integer, toExclusive As Integer) As OrderablePartitioner(Of Tuple(Of Integer, Integer))

Parameters

fromInclusive
Int32

The lower, inclusive bound of the range.

toExclusive
Int32

The upper, exclusive bound of the range.

Returns

A partitioner.

Exceptions

The toExclusive argument is less than or equal to the fromInclusive argument.

Remarks

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

See also

Applies to

Create(Int64, Int64)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates a partitioner that chunks the user-specified range.

public:
 static System::Collections::Concurrent::OrderablePartitioner<Tuple<long, long> ^> ^ Create(long fromInclusive, long toExclusive);
public static System.Collections.Concurrent.OrderablePartitioner<Tuple<long,long>> Create (long fromInclusive, long toExclusive);
static member Create : int64 * int64 -> System.Collections.Concurrent.OrderablePartitioner<int64 * int64>
Public Shared Function Create (fromInclusive As Long, toExclusive As Long) As OrderablePartitioner(Of Tuple(Of Long, Long))

Parameters

fromInclusive
Int64

The lower, inclusive bound of the range.

toExclusive
Int64

The upper, exclusive bound of the range.

Returns

A partitioner.

Exceptions

The toExclusive argument is less than or equal to the fromInclusive argument.

Remarks

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

See also

Applies to

Create(Int32, Int32, Int32)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates a partitioner that chunks the user-specified range.

public:
 static System::Collections::Concurrent::OrderablePartitioner<Tuple<int, int> ^> ^ Create(int fromInclusive, int toExclusive, int rangeSize);
public static System.Collections.Concurrent.OrderablePartitioner<Tuple<int,int>> Create (int fromInclusive, int toExclusive, int rangeSize);
static member Create : int * int * int -> System.Collections.Concurrent.OrderablePartitioner<int * int>
Public Shared Function Create (fromInclusive As Integer, toExclusive As Integer, rangeSize As Integer) As OrderablePartitioner(Of Tuple(Of Integer, Integer))

Parameters

fromInclusive
Int32

The lower, inclusive bound of the range.

toExclusive
Int32

The upper, exclusive bound of the range.

rangeSize
Int32

The size of each subrange.

Returns

A partitioner.

Exceptions

The toExclusive argument is less than or equal to the fromInclusive argument.

-or-

The rangeSize argument is less than or equal to 0.

Remarks

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

See also

Applies to

Create(Int64, Int64, Int64)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates a partitioner that chunks the user-specified range.

public:
 static System::Collections::Concurrent::OrderablePartitioner<Tuple<long, long> ^> ^ Create(long fromInclusive, long toExclusive, long rangeSize);
public static System.Collections.Concurrent.OrderablePartitioner<Tuple<long,long>> Create (long fromInclusive, long toExclusive, long rangeSize);
static member Create : int64 * int64 * int64 -> System.Collections.Concurrent.OrderablePartitioner<int64 * int64>
Public Shared Function Create (fromInclusive As Long, toExclusive As Long, rangeSize As Long) As OrderablePartitioner(Of Tuple(Of Long, Long))

Parameters

fromInclusive
Int64

The lower, inclusive bound of the range.

toExclusive
Int64

The upper, exclusive bound of the range.

rangeSize
Int64

The size of each subrange.

Returns

A partitioner.

Exceptions

The toExclusive argument is less than or equal to the fromInclusive argument.

-or-

The rangeSize argument is less than or equal to 0.

Remarks

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

See also

Applies to

Create<TSource>(IEnumerable<TSource>)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates an orderable partitioner from a IEnumerable<T> instance.

public:
generic <typename TSource>
 static System::Collections::Concurrent::OrderablePartitioner<TSource> ^ Create(System::Collections::Generic::IEnumerable<TSource> ^ source);
public static System.Collections.Concurrent.OrderablePartitioner<TSource> Create<TSource> (System.Collections.Generic.IEnumerable<TSource> source);
static member Create : seq<'Source> -> System.Collections.Concurrent.OrderablePartitioner<'Source>
Public Shared Function Create(Of TSource) (source As IEnumerable(Of TSource)) As OrderablePartitioner(Of TSource)

Type Parameters

TSource

Type of the elements in source enumerable.

Parameters

source
IEnumerable<TSource>

The enumerable to be partitioned.

Returns

An orderable partitioner based on the input array.

Remarks

The ordering used in the created partitioner is determined by the natural order of the elements as retrieved from the source enumerable. For more information and examples, see Custom Partitioners for PLINQ and TPL.

See also

Applies to

Create<TSource>(IEnumerable<TSource>, EnumerablePartitionerOptions)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates an orderable partitioner from a IEnumerable<T> instance.

public:
generic <typename TSource>
 static System::Collections::Concurrent::OrderablePartitioner<TSource> ^ Create(System::Collections::Generic::IEnumerable<TSource> ^ source, System::Collections::Concurrent::EnumerablePartitionerOptions partitionerOptions);
public static System.Collections.Concurrent.OrderablePartitioner<TSource> Create<TSource> (System.Collections.Generic.IEnumerable<TSource> source, System.Collections.Concurrent.EnumerablePartitionerOptions partitionerOptions);
static member Create : seq<'Source> * System.Collections.Concurrent.EnumerablePartitionerOptions -> System.Collections.Concurrent.OrderablePartitioner<'Source>
Public Shared Function Create(Of TSource) (source As IEnumerable(Of TSource), partitionerOptions As EnumerablePartitionerOptions) As OrderablePartitioner(Of TSource)

Type Parameters

TSource

Type of the elements in source enumerable.

Parameters

source
IEnumerable<TSource>

The enumerable to be partitioned.

partitionerOptions
EnumerablePartitionerOptions

Options to control the buffering behavior of the partitioner.

Returns

An orderable partitioner based on the input array.

Exceptions

The partitionerOptions argument specifies an invalid value for EnumerablePartitionerOptions.

Remarks

The ordering used in the created partitioner is determined by the natural order of the elements as retrieved from the source enumerable.

Applies to

Create<TSource>(IList<TSource>, Boolean)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates an orderable partitioner from an IList<T> instance.

public:
generic <typename TSource>
 static System::Collections::Concurrent::OrderablePartitioner<TSource> ^ Create(System::Collections::Generic::IList<TSource> ^ list, bool loadBalance);
public static System.Collections.Concurrent.OrderablePartitioner<TSource> Create<TSource> (System.Collections.Generic.IList<TSource> list, bool loadBalance);
static member Create : System.Collections.Generic.IList<'Source> * bool -> System.Collections.Concurrent.OrderablePartitioner<'Source>
Public Shared Function Create(Of TSource) (list As IList(Of TSource), loadBalance As Boolean) As OrderablePartitioner(Of TSource)

Type Parameters

TSource

Type of the elements in source list.

Parameters

list
IList<TSource>

The list to be partitioned.

loadBalance
Boolean

A Boolean value that indicates whether the created partitioner should dynamically load balance between partitions rather than statically partition.

Returns

An orderable partitioner based on the input list.

Remarks

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

See also

Applies to

Create<TSource>(TSource[], Boolean)

Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs
Source:
PartitionerStatic.cs

Creates an orderable partitioner from a Array instance.

public:
generic <typename TSource>
 static System::Collections::Concurrent::OrderablePartitioner<TSource> ^ Create(cli::array <TSource> ^ array, bool loadBalance);
public static System.Collections.Concurrent.OrderablePartitioner<TSource> Create<TSource> (TSource[] array, bool loadBalance);
static member Create : 'Source[] * bool -> System.Collections.Concurrent.OrderablePartitioner<'Source>
Public Shared Function Create(Of TSource) (array As TSource(), loadBalance As Boolean) As OrderablePartitioner(Of TSource)

Type Parameters

TSource

Type of the elements in source array.

Parameters

array
TSource[]

The array to be partitioned.

loadBalance
Boolean

A Boolean value that indicates whether the created partitioner should dynamically load balance between partitions rather than statically partition.

Returns

An orderable partitioner based on the input array.

Remarks

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

See also

Applies to