Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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

Computes the sum of the sequence of nullable 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)
'Declaration
<ExtensionAttribute> _
Public Shared Function Sum(Of TSource) ( _
	source As IEnumerable(Of TSource), _
	selector As Func(Of TSource, Nullable(Of Double)) _
) As Nullable(Of Double)

Type Parameters

TSource

The type of the elements of source.

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, Nullable(Of Double))
A transform function to apply to each element.

Return Value

Type: System.Nullable(Of Double)
The sum of the projected values.

Usage Note

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

source or selector is Nothing.

This method returns zero if source contains no elements.

The result does not include values that are Nothing.

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 Nullable<Double> in C# or Nullable(Of Double) in Visual Basic.

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

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.

NoteNote:

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.


   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.
      outputBlock.Text &= "The total weight of the packages is: " & totalWeight & VbCrLf
   End Sub

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



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

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

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.