Enumerable.Sum(Of TSource) Method (IEnumerable(Of TSource), Func(Of TSource, Double))

.NET Framework (current version)

Computes the sum of the sequence of Double 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

C++

<ExtensionAttribute>
Public Shared Function Sum(Of TSource) (
	source As IEnumerable(Of TSource),
	selector As Func(Of TSource, Double)
) As Double

Parameters

source: Type: System.Collections.Generic.IEnumerable(Of TSource)
A sequence of values that are used to calculate a sum.

selector: Type: System.Func(Of TSource, Double)
A transform function to apply to each element.

Return Value

Type: System.Double

The sum of the projected values.

Type Parameters

TSource: The type of the elements of source.

Exceptions

Exception	Condition
ArgumentNullException	source or selector is null.

Remarks

This method returns zero if source contains no elements.

You can apply this method to a sequence of arbitrary values if you provide a function, selector, that projects the members of source into a numeric type, specifically Double.

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

Examples

The following code example demonstrates how to use Sum(Of TSource)(IEnumerable(Of TSource), Func(Of TSource, Double)) to sum the projected values of a sequence.

Structure Package
    Public Company As String
    Public Weight As Double
End Structure

Sub SumEx1()
    ' Create a list of Package values.
    Dim packages As New List(Of Package)(New Package() _
     {New Package With {.Company = "Coho Vineyard", .Weight = 25.2},
      New Package With {.Company = "Lucerne Publishing", .Weight = 18.7},
      New Package With {.Company = "Wingtip Toys", .Weight = 6.0},
      New Package With {.Company = "Adventure Works", .Weight = 33.8}})

    ' Sum the values from each item's Weight property.
    Dim totalWeight As Double = packages.Sum(Function(pkg) _
                                             pkg.Weight)

    ' Display the result.
    MsgBox("The total weight of the packages is: " & totalWeight)
End Sub

' This code produces the following output:
'
' The total weight of the packages is: 83.7

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