Export (0) Print
Expand All

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

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

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

static member Intersect : 
        first:IEnumerable<'TSource> * 
        second:IEnumerable<'TSource> -> IEnumerable<'TSource> 

Type Parameters

TSource

The type of the elements of the input sequences.

Parameters

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

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

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

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

Return Value

Type: System.Collections.Generic.IEnumerable(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(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 a null reference (Nothing in Visual Basic).

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(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(TSource)(IEnumerable(TSource), IEnumerable(TSource)) to return the elements that appear in each of two sequences of integers.

No code example is currently available or this language may not be supported.

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

public class ProductA
{ 
    public string Name { get; set; }
    public int Code { get; set; }
}

public class ProductComparer : IEqualityComparer<ProductA>
{

    public bool Equals(ProductA x, ProductA y)
    {
        //Check whether the objects are the same object.  
        if (Object.ReferenceEquals(x, y)) return true;

        //Check whether the products' properties are equal.  
        return x != null && y != null && x.Code.Equals(y.Code) && x.Name.Equals(y.Name);
    }

    public int GetHashCode(ProductA obj)
    {
        //Get hash code for the Name field if it is not null.  
        int hashProductName = obj.Name == null ? 0 : obj.Name.GetHashCode();

        //Get hash code for the Code field.  
        int hashProductCode = obj.Code.GetHashCode();

        //Calculate the hash code for the product.  
        return hashProductName ^ hashProductCode;
    }
}

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

No code example is currently available or this language may not be supported.

.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.

Show:
© 2014 Microsoft