BatchExtensionBatchTSource Method (IEnumerableTSource, Int32)

public static IEnumerable<IEnumerable<TSource>> Batch<TSource>(
	this IEnumerable<TSource> source,
	int size
)

<ExtensionAttribute>
Public Shared Function Batch(Of TSource) ( 
	source As IEnumerable(Of TSource),
	size As Integer
) As IEnumerable(Of IEnumerable(Of TSource))

public:
[ExtensionAttribute]
generic<typename TSource>
static IEnumerable<IEnumerable<TSource>^>^ Batch(
	IEnumerable<TSource>^ source, 
	int size
)

[<ExtensionAttribute>]
static member Batch : 
        source : IEnumerable<'TSource> * 
        size : int -> IEnumerable<IEnumerable<'TSource>> 

Parameters

source

Type: System.Collections.GenericIEnumerableTSource
The source sequence.

size

Type: SystemInt32
Size of buckets.

Type Parameters

TSource

Type of elements in source sequence.

Return Value

Usage Note

This operator uses deferred execution and streams its results (buckets are streamed but their content buffered).

When more than one bucket is streamed, 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.

Each bucket is pre-allocated to size elements. If size is set to a very large value, e.g. MaxValue to effectively disable batching by just hoping for a single bucket, then it can lead to memory exhaustion (OutOfMemoryException).

Reference