Enumerable.Intersect(Of TSource) Method (IEnumerable(Of TSource), IEnumerable(Of TSource), IEqualityComparer(Of TSource))

Produces the set intersection of two sequences by using the specified IEqualityComparer(Of T) to compare values.

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

'Declaration
<ExtensionAttribute> _
Public Shared Function Intersect(Of TSource) ( _
	first As IEnumerable(Of TSource), _
	second As IEnumerable(Of TSource), _
	comparer As IEqualityComparer(Of TSource) _
) As IEnumerable(Of TSource)

Type Parameters

TSource

The type of the elements of the input sequences.

Parameters

first
Type: System.Collections.Generic.IEnumerable(Of TSource)

An IEnumerable(Of T) whose distinct elements that also appear in second will be returned.

second
Type: System.Collections.Generic.IEnumerable(Of TSource)

An IEnumerable(Of T) whose distinct elements that also appear in the first sequence will be returned.

comparer
Type: System.Collections.Generic.IEqualityComparer(Of TSource)

An IEqualityComparer(Of T) to compare values.

Return Value

Type: System.Collections.Generic.IEnumerable(Of TSource)
A sequence that contains the elements that form the set intersection of two sequences.

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. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

ExceptionCondition
ArgumentNullException

first or second is Nothing.

This method is implemented by using deferred execution. The immediate return value is an object that stores all the information that is required to perform the action. The query represented by this method is not executed until the object is enumerated either by calling its GetEnumerator method directly or by using foreach in Visual C# or For Each in Visual Basic.

The intersection of two sets A and B is defined as the set that contains all the elements of A that also appear in B, but no other elements.

When the object returned by this method is enumerated, Intersect enumerates first, collecting all distinct elements of that sequence. It then enumerates second, marking those elements that occur in both sequences. Finally, the marked elements are yielded in the order in which they were collected.

If comparer is Nothing, the default equality comparer, Default, is used to compare values.

The following example shows how to implement an equality comparer that can be used in the Intersect method.

Public Class Product
    Public Property Name As String 
    Public Property Code As Integer 
End Class 

' Custom comparer for the Product class 
Public Class ProductComparer
    Implements IEqualityComparer(Of Product)

    Public Function Equals1(
        ByVal x As Product, 
        ByVal y As Product
        ) As Boolean Implements IEqualityComparer(Of Product).Equals

        ' Check whether the compared objects reference the same data. 
        If x Is y Then Return True 

        'Check whether any of the compared objects is null. 
        If x Is Nothing OrElse y Is Nothing Then Return False 

        ' Check whether the products' properties are equal. 
        Return (x.Code = y.Code) AndAlso (x.Name = y.Name)
    End Function 

    Public Function GetHashCode1(
        ByVal product As Product
        ) As Integer Implements IEqualityComparer(Of Product).GetHashCode

        ' Check whether the object is null. 
        If product Is Nothing Then Return 0

        ' Get hash code for the Name field if it is not null. 
        Dim hashProductName = 
            If(product.Name Is Nothing, 0, product.Name.GetHashCode())

        ' Get hash code for the Code field. 
        Dim hashProductCode = product.Code.GetHashCode()

        ' Calculate the hash code for the product. 
        Return hashProductName Xor hashProductCode
    End Function 
End Class

After you implement this comparer, you can use sequences of Product objects in the Intersect method, as shown in the following example.

Dim store1() As Product = 
    {New Product With {.Name = "apple", .Code = 9}, 
     New Product With {.Name = "orange", .Code = 4}}

Dim store2() As Product = 
    {New Product With {.Name = "apple", .Code = 9}, 
     New Product With {.Name = "lemon", .Code = 12}}


...


' Get the products from the first array  
' that have duplicates in the second array. 

Dim duplicates = store1.Intersect(store2, New ProductComparer())

For Each product In duplicates
    Console.WriteLine(product.Name & " " & product.Code)
Next 

' This code produces the following output: 

' apple 9 
' 

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft