MoreEnumerable.Scan(TSource) Method (IEnumerable(TSource), Func(TSource, TSource, TSource))

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

Syntax

public static IEnumerable<TSource> Scan<TSource>(
	this IEnumerable<TSource> source,
	Func<TSource, TSource, TSource> transformation
)

<ExtensionAttribute>
Public Shared Function Scan(Of TSource) ( 
	source As IEnumerable(Of TSource),
	transformation As Func(Of TSource, TSource, TSource)
) As IEnumerable(Of TSource)

public:
[ExtensionAttribute]
generic<typename TSource>
static IEnumerable<TSource>^ Scan(
	IEnumerable<TSource>^ source, 
	Func<TSource, TSource, TSource>^ transformation
)

[<ExtensionAttribute>]
static member Scan : 
        source : IEnumerable<'TSource> * 
        transformation : Func<'TSource, 'TSource, 'TSource> -> IEnumerable<'TSource>

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

Exception	Condition
InvalidOperationException	If source is empty.

Remarks

An inclusive prefix sum returns an equal-length sequence where the N-th element is the sum of the first N input elements. More generally, the scan allows any commutative binary operation, not just a sum. The exclusive version of Scan is PreScanTSource(IEnumerableTSource, FuncTSource, TSource, TSource, TSource). This operator uses deferred execution and streams its result.

Examples

Copy

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.

Reference

MoreEnumerable Class

Scan Overload

MoreLinq Namespace