Share via

  • Article

Enumerable.Average<TSource> Method (IEnumerable<TSource>, Func<TSource, Int32>)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Computes the average of a sequence of Int32 values that are obtained by invoking a transform function on each element of the input sequence.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Average(Of TSource) ( _
    source As IEnumerable(Of TSource), _
    selector As Func(Of TSource, Integer) _
) As Double

public static double Average<TSource>(
    this IEnumerable<TSource> source,
    Func<TSource, int> selector
)

Type Parameters

  • TSource
    The type of the elements of source.

Parameters

  • selector
    Type: System.Func<TSource, Int32>
    A transform function to apply to each element.

Return Value

Type: System.Double
The average of the sequence of values.

Usage Note

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

Exceptions

Exception Condition
ArgumentNullException

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

source contains no elements.
OverflowException

The sum of the elements in the sequence is larger than MaxValue.

Remarks

In Visual Basic query expression syntax, an Aggregate Into Average() clause translates to an invocation of Average.

Examples

The following code example demonstrates how to use Average<TSource>(IEnumerable<TSource>, Func<TSource, Int32>) to calculate an average.

      ' Create an array of strings.
      Dim fruits() As String = _
          {"apple", "banana", "mango", "orange", "passionfruit", "grape"}

      ' Determine the average length of the strings in the array.
      Dim avg As Double = fruits.Average(Function(s) s.Length)

      ' Display the output.
      outputBlock.Text &= "The average string length is " & avg & vbCrLf

      ' This code produces the following output:
      '
      ' The average string length is 6.5


      string[] fruits = { "apple", "banana", "mango", "orange", "passionfruit", "grape" };

      double average = fruits.Average(s => s.Length);

      outputBlock.Text += String.Format("The average string length is {0}.", average) + "\n";

      // This code produces the following output:
      //
      // The average string length is 6.5.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

Platforms

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