Queryable.Aggregate<TSource, TAccumulate> Method (IQueryable<TSource>, TAccumulate, Expression<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)

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Aggregate(Of TSource, TAccumulate) ( _
    source As IQueryable(Of TSource), _
    seed As TAccumulate, _
    func As Expression(Of Func(Of TAccumulate, TSource, TAccumulate)) _
) As TAccumulate
public static TAccumulate Aggregate<TSource, TAccumulate>(
    this IQueryable<TSource> source,
    TAccumulate seed,
    Expression<Func<TAccumulate, TSource, TAccumulate>> func
)

Type Parameters

  • TSource
    The type of the elements of source.
  • TAccumulate
    The type of the accumulator value.

Parameters

  • seed
    Type: TAccumulate
    The initial accumulator value.

Return Value

Type: TAccumulate
The final accumulator value.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable<TSource>. When you use instance method syntax to call this method, omit the first parameter.

Exceptions

Exception Condition
ArgumentNullException

source or func is nulla null reference (Nothing in Visual Basic).

Remarks

This method has at least one parameter of type Expression<TDelegate> whose type argument is one of the Func<T, TResult> types. For these parameters, you can pass in a lambda expression and it will be compiled to an Expression<TDelegate>.

The Aggregate<TSource, TAccumulate>(IQueryable<TSource>, TAccumulate, Expression<Func<TAccumulate, TSource, TAccumulate>>) method generates a MethodCallExpression that represents calling Aggregate<TSource, TAccumulate>(IQueryable<TSource>, TAccumulate, Expression<Func<TAccumulate, TSource, TAccumulate>>) itself as a constructed generic method. It then passes the MethodCallExpression to the Execute<TResult>(Expression) method of the IQueryProvider represented by the Provider property of the source parameter.

The query behavior that occurs as a result of executing an expression tree that represents calling Aggregate<TSource, TAccumulate>(IQueryable<TSource>, TAccumulate, Expression<Func<TAccumulate, TSource, TAccumulate>>) depends on the implementation of the type of the source parameter. The expected behavior is that the specified function, func, is applied to each value in the source sequence and the accumulated value is returned. The seed parameter is used as the seed value for the accumulated value, which corresponds to the first parameter in func.

To simplify common aggregation operations, the set of standard query operators also includes two counting methods, Count and LongCount, and four numeric aggregation methods, namely Max, Min, Sum, and Average.

Examples

The following code example demonstrates how to use Aggregate<TSource, TAccumulate>(IQueryable<TSource>, TAccumulate, Expression<Func<TAccumulate, TSource, TAccumulate>>) to apply an accumulator function when a seed value is provided to the function.

      Dim ints() As Integer = {4, 8, 8, 3, 9, 0, 7, 8, 2}

      ' Count the even numbers in the array, using a seed value of 0.
      Dim numEven As Integer = _
          ints.AsQueryable().Aggregate( _
              0, _
              Function(total, number) _
                  IIf(number Mod 2 = 0, total + 1, total) _
          )

      outputBlock.Text &= String.Format("The number of even integers is: {0}", numEven) & vbCrLf

      ' This code produces the following output:
      '
      ' The number of even integers is: 6 

         int[] ints = { 4, 8, 8, 3, 9, 0, 7, 8, 2 };

         // Count the even numbers in the array, using a seed value of 0.
         int numEven =
             ints.AsQueryable().Aggregate(
             0,
             (total, next) => next % 2 == 0 ? total + 1 : total
             );

         outputBlock.Text += String.Format("The number of even integers is: {0}", numEven) + "\n";

         // This code produces the following output:
         //
         // The number of even integers is: 6 

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.