Windows apps
Collapse the table of content
Expand the table of content
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Enumerable::Aggregate<TSource> Method (IEnumerable<TSource>^, Func<TSource, TSource, TSource>^)

 

Applies an accumulator function over a sequence.

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

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

Parameters

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

An IEnumerable<T> to aggregate over.

func
Type: System::Func<TSource, TSource, TSource>^

An accumulator function to be invoked on each element.

Return Value

Type: TSource

The final accumulator value.

Type Parameters

TSource

The type of the elements of source.

Exception Condition
ArgumentNullException

source or func is null.

InvalidOperationException

source contains no elements.

The Aggregate<TSource>(IEnumerable<TSource>^, Func<TSource, TSource, TSource>^) 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 sourceexcept the first one. Each time func is called, Aggregate<TSource>(IEnumerable<TSource>^, Func<TSource, TSource, TSource>^) passes both the element from the sequence and an aggregated value (as the first argument to func). The first element of source is used as the initial aggregate value. The result of func replaces the previous aggregated value. Aggregate<TSource>(IEnumerable<TSource>^, Func<TSource, TSource, TSource>^) returns the final result of func.

This overload of the Aggregate<TSource>methodisn't suitable for all casesbecause it uses the first element of source as the initial aggregate value. You should choose another overload if the return value should include only the elements of source that meet a certain condition. For example, this overload isn't reliableif you want to calculate the sum of the even numbers in source. The result will be incorrect if the first element is odd instead of even.

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 reverse the order of words in a string by usingAggregate<TSource>.

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