Click or drag to resize

MoreEnumerableScanTSource Method (IEnumerableTSource, FuncTSource, TSource, TSource)

Peforms a scan (inclusive prefix sum) on a sequence of elements.

Namespace:  MoreLinq
Assembly:  MoreLinq (in MoreLinq.dll) Version: 2.4.0
Syntax
public static IEnumerable<TSource> Scan<TSource>(
	this IEnumerable<TSource> source,
	Func<TSource, TSource, TSource> transformation
)

Parameters

source
Type: System.Collections.GenericIEnumerableTSource
Source sequence
transformation
Type: SystemFuncTSource, TSource, TSource
Transformation operation

Type Parameters

TSource
Type of elements in source sequence

Return Value

Type: IEnumerableTSource
The scanned sequence

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).
Exceptions
ExceptionCondition
InvalidOperationExceptionIf source is empty.
Remarks
Examples
Func<int, int, int> plus = (a, b) => a + b;
int[] values = { 1, 2, 3, 4 };
IEnumerable<int> prescan = values.PreScan(plus, 0);
IEnumerable<int> scan = values.Scan(plus; a + b);
IEnumerable<int> result = values.ZipShortest(prescan, plus);
prescan will yield { 0, 1, 3, 6 }, while scan and result will both yield { 1, 3, 6, 10 }. This shows the relationship between the inclusive and exclusive prefix sum.
See Also