Aggregate(TSource, TAccumulate) Method (IEnumerable(TSource), TAccumulate, Func(TAccumulate, TSource, TAccumulate))

Enumerable.Aggregate<'TSource, 'TAccumulate> Method (IEnumerable<'TSource>, 'TAccumulate, Func<'TAccumulate, 'TSource, 'TAccumulate>)

 

Applies an accumulator function over a sequence. The specified seed value is used as the initial accumulator value.

Namespace:   System.Linq
Assembly:  System.Core (in System.Core.dll)

static member Aggregate<'TSource, 'TAccumulate> : 
        source:IEnumerable<'TSource> *
        seed:'TAccumulate *
        func:Func<'TAccumulate, 'TSource, 'TAccumulate> -> 'TAccumulate

Parameters

source
Type: System.Collections.Generic.IEnumerable<'TSource>

An IEnumerable<'T> to aggregate over.

seed
Type: TAccumulate

The initial accumulator value.

func
Type: System.Func<'TAccumulate, 'TSource, 'TAccumulate>

An accumulator function to be invoked on each element.

Return Value

Type: TAccumulate

The final accumulator value.

Type Parameters

TSource

The type of the elements of source.

TAccumulate

The type of the accumulator value.

Exception Condition
ArgumentNullException

source or func is null.

The Aggregate<'TSource, 'TAccumulate>(IEnumerable<'TSource>, 'TAccumulate, Func<'TAccumulate, 'TSource, 'TAccumulate>) method makes it simple to perform a calculation over a sequence of values. This method works by calling func one time for each element in source. Each time func is called, Aggregate<'TSource, 'TAccumulate>(IEnumerable<'TSource>, 'TAccumulate, Func<'TAccumulate, 'TSource, 'TAccumulate>) passes both the element from the sequence and an aggregated value (as the first argument to func). The value of the seed parameter is used as the initial aggregate value. The result of func replaces the previous aggregated value. Aggregate<'TSource, 'TAccumulate>(IEnumerable<'TSource>, 'TAccumulate, Func<'TAccumulate, 'TSource, 'TAccumulate>) returns the final result of func.

To simplify common aggregation operations, the standard query operators also include a general purpose count method, Count<'TSource>, and four numeric aggregation methods, namely Min, Max, Sum, and Average.

The following code example demonstrates how to use Aggregate<'TSource, 'TAccumulate> to apply an accumulator function and use a seed value.

No code example is currently available or this language may not be supported.

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.5
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft