ExperimentalEnumerableBatchTSource, TBucket, TResult(IEnumerableTSource, Int32, ArrayPoolTSource, FuncICurrentBufferTSource, IEnumerableTBucket, FuncIEnumerableTBucket, TResult) Method

public static IEnumerable<TResult> Batch<TSource, TBucket, TResult>(
	this IEnumerable<TSource> source,
	int size,
	ArrayPool<TSource> pool,
	Func<ICurrentBuffer<TSource>, IEnumerable<TBucket>> bucketProjectionSelector,
	Func<IEnumerable<TBucket>, TResult> resultSelector
)

<ExtensionAttribute>
Public Shared Function Batch(Of TSource, TBucket, TResult) ( 
	source As IEnumerable(Of TSource),
	size As Integer,
	pool As ArrayPool(Of TSource),
	bucketProjectionSelector As Func(Of ICurrentBuffer(Of TSource), IEnumerable(Of TBucket)),
	resultSelector As Func(Of IEnumerable(Of TBucket), TResult)
) As IEnumerable(Of TResult)

public:
[ExtensionAttribute]
generic<typename TSource, typename TBucket, typename TResult>
static IEnumerable<TResult>^ Batch(
	IEnumerable<TSource>^ source, 
	int size, 
	ArrayPool<TSource>^ pool, 
	Func<ICurrentBuffer<TSource>^, IEnumerable<TBucket>^>^ bucketProjectionSelector, 
	Func<IEnumerable<TBucket>^, TResult>^ resultSelector
)

[<ExtensionAttribute>]
static member Batch : 
        source : IEnumerable<'TSource> * 
        size : int * 
        pool : ArrayPool<'TSource> * 
        bucketProjectionSelector : Func<ICurrentBuffer<'TSource>, IEnumerable<'TBucket>> * 
        resultSelector : Func<IEnumerable<'TBucket>, 'TResult> -> IEnumerable<'TResult> 

Parameters

source  IEnumerableTSource

The source sequence.

size  Int32

Size of buckets.

pool  ArrayPoolTSource

The pool used to rent the array for each bucket.

bucketProjectionSelector  FuncICurrentBufferTSource, IEnumerableTBucket

A function that returns a sequence projection to use for each bucket. It is called initially before iterating over source, but the resulting projection is evaluated for each bucket. This has the same effect as calling bucketProjectionSelector for each bucket, but allows initialization of the transformation to happen only once.

resultSelector  FuncIEnumerableTBucket, TResult

A function that projects a result from the input sequence produced over a bucket.

Type Parameters

TSource

Type of elements in source sequence.

TBucket

Type of elements in the sequence returned by bucketProjectionSelector.

TResult

Type of elements of the resulting sequence.

Return Value

Usage Note

This operator uses deferred execution and streams its results (however, each bucket is buffered).

Each bucket is backed by a rented array that may be at least size in length.

When more than one bucket is produced, all buckets except the last is guaranteed to have size elements. The last bucket may be smaller depending on the remaining elements in the source sequence.

Reference