Enumerable.Intersect Method (System.Linq) (original) (raw)

Source:

Produces the set intersection of two sequences by using the default equality comparer to compare values.

public:
generic <typename TSource>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Generic::IEnumerable<TSource> ^ Intersect(System::Collections::Generic::IEnumerable<TSource> ^ first, System::Collections::Generic::IEnumerable<TSource> ^ second);

public static System.Collections.Generic.IEnumerable<TSource> Intersect<TSource>(this System.Collections.Generic.IEnumerable<TSource> first, System.Collections.Generic.IEnumerable<TSource> second);

static member Intersect : seq<'Source> * seq<'Source> -> seq<'Source>

<Extension()>
Public Function Intersect(Of TSource) (first As IEnumerable(Of TSource), second As IEnumerable(Of TSource)) As IEnumerable(Of TSource)

Type Parameters

TSource

The type of the elements of the input sequences.

Parameters

second

IEnumerable

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

Returns

A sequence that contains the elements that form the set intersection of two sequences.

Exceptions

Examples

The following code example demonstrates how to use Intersect<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) to return the elements that appear in each of two sequences of integers.

int[] id1 = { 44, 26, 92, 30, 71, 38 };
int[] id2 = { 39, 59, 83, 47, 26, 4, 30 };

IEnumerable<int> both = id1.Intersect(id2);

foreach (int id in both)
    Console.WriteLine(id);

/*
 This code produces the following output:

 26
 30
*/

' 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.
Console.WriteLine(output.ToString)

' This code produces the following output:
'
' 26
' 30

If you want to compare sequences of objects of some custom data type, you have to implement the IEquatable generic interface in a helper class. The following code example shows how to implement this interface in a custom data type and override GetHashCode and Equals methods.

public class ProductA : IEquatable<ProductA>
{
    public string Name { get; set; }
    public int Code { get; set; }

    public bool Equals(ProductA other)
    {
        if (other is null)
            return false;

        return this.Name == other.Name && this.Code == other.Code;
    }

    public override bool Equals(object obj) => Equals(obj as ProductA);
    public override int GetHashCode() => (Name, Code).GetHashCode();
}

Public Class ProductA
    Inherits IEquatable(Of ProductA)

    Public Property Name As String
    Public Property Code As Integer

    Public Function Equals(ByVal other As ProductA) As Boolean
        If other Is Nothing Then Return False
        Return Me.Name = other.Name AndAlso Me.Code = other.Code
    End Function

    Public Overrides Function Equals(ByVal obj As Object) As Boolean
        Return Equals(TryCast(obj, ProductA))
    End Function

    Public Overrides Function GetHashCode() As Integer
        Return (Name, Code).GetHashCode()
    End Function

End Class

After you implement this interface, you can use sequences of ProductA objects in the Intersect method, as shown in the following example:

ProductA[] store1 = { new ProductA { Name = "apple", Code = 9 },
                       new ProductA { Name = "orange", Code = 4 } };

ProductA[] store2 = { new ProductA { Name = "apple", Code = 9 },
                       new ProductA { Name = "lemon", Code = 12 } };

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

Dim store2() As ProductA = 
    {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.

IEnumerable<ProductA> duplicates =
    store1.Intersect(store2);

foreach (var product in duplicates)
    Console.WriteLine(product.Name + " " + product.Code);

/*
    This code produces the following output:
    apple 9
*/

' Get the products from the first array 
' that have duplicates 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
'

Remarks

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 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 yields distinct elements occurring in both sequences in the order in which they appear in first.

The default equality comparer, Default, is used to compare values of the types. To compare a custom data type, you need to override the Equals and the GetHashCode methods, and optionally implement the IEquatable generic interface in the custom type. For more information, see the Default property.