BatchExtensionBatchTSource(IEnumerableTSource, Int32) Method

Batches the source sequence into sized buckets.

Definition

Namespace: MoreLinq.Extensions
Assembly: MoreLinq (in MoreLinq.dll) Version: 3.4.0+b99a6a8cc504caf2d48372fe54a2f8116c59cd0c

C#

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

VB

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

C++

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

F#

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

Parameters

source IEnumerableTSource: The source sequence.
size Int32: Size of buckets.

Type Parameters

TSource: Type of elements in source sequence.

Return Value

IEnumerableIEnumerableTSource
A sequence of equally sized buckets containing elements of the source collection.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableTSource. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

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).