Enumerable.Intersect(Of TSource) Method (IEnumerable(Of TSource), IEnumerable(Of TSource))
Updated: October 2008
Produces the set intersection of two sequences by using the default equality comparer to compare values.
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) _ ) As IEnumerable(Of TSource) 'Usage Dim first As IEnumerable(Of TSource) Dim second As IEnumerable(Of TSource) Dim returnValue As IEnumerable(Of TSource) returnValue = first.Intersect(second)
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.
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).| Exception | Condition |
|---|---|
| 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.
The default equality comparer, Default, is used to compare values of the types that implement the IEqualityComparer(Of T) generic interface. To compare a custom data type, you need to implement this interface and provide your own GetHashCode and Equals methods for the type.
The following code example demonstrates how to use Intersect(Of TSource)(IEnumerable(Of TSource), IEnumerable(Of TSource)) to return the elements that appear in each of two sequences of integers.
' Create two integer arrays. Dim id1() As Integer = {44, 26, 92, 30, 71, 38} Dim id2() As Integer = {39, 59, 83, 47, 26, 4, 30} ' Find the set intersection of the two arrays. Dim intersection As IEnumerable(Of Integer) = id1.Intersect(id2) Dim output As New System.Text.StringBuilder For Each id As Integer In intersection output.AppendLine(id) Next ' Display the output. MsgBox(output.ToString) ' This code produces the following output: ' ' 26 ' 30
If you want to compare sequences of objects of a custom data type, you have to implement the IEqualityComparer(Of T) generic interface in the class. The following code example shows how to implement this interface in a custom data type and provide GetHashCode and Equals methods.
Public Class Product Implements IEquatable(Of Product) Public Name As String Public Code As Integer Public Function Equals1(ByVal other As Product) As Boolean _ Implements IEquatable(Of Product).Equals ' Check whether the compared object is null. If other Is Nothing Then Return False ' Check whether the compared object references the same data. If Me Is Other Then Return True ' Check whether the products' properties are equal. Return Code.Equals(other.Code) AndAlso Name.Equals(other.Name) End Function Public Overrides Function GetHashCode() As Integer ' Get the hash code for the Name field if it is not null. Dim hashProductName = If(Name Is Nothing, 0, Name.GetHashCode()) ' Get the hash code for the Code field. Dim hashProductCode = Code.GetHashCode() ' Calculate the hash code for the product. Return hashProductName Xor hashProductCode End Function End Class
After you implement this interface, 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 also appear in the second array. Dim duplicates = store1.Intersect(store2) For Each product In duplicates Console.WriteLine(product.Name & " " & product.Code) Next ' This code produces the following output: ' ' apple 9 '
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.