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

Computes the average of a sequence of nullable 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, Nullable(Of Integer)) _
) As Nullable(Of Double)
public static Nullable<double> Average<TSource>(
    this IEnumerable<TSource> source,
    Func<TSource, Nullable<int>> selector
)

Type Parameters

  • TSource
    The type of the elements of source.

Parameters

Return Value

Type: System.Nullable<Double>
The average of the sequence of values, or nulla null reference (Nothing in Visual Basic) if the source sequence is empty or contains only values that are nulla null reference (Nothing in Visual Basic).

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

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.

Note

This code example uses an overload of this overloaded method that is different from the specific overload that this topic describes. To extend the example to this topic, change the body of the selector function.

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

See Also

Reference

Enumerable Class

Average Overload

System.Linq Namespace