Condividi tramite

  • Articolo

Enumerable.Distinct<TSource> Method (IEnumerable<TSource>)

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Returns distinct elements from a sequence by using the default equality comparer to compare values.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Function Distinct(Of TSource) ( _
    source As IEnumerable(Of TSource) _
) As IEnumerable(Of TSource)

public static IEnumerable<TSource> Distinct<TSource>(
    this IEnumerable<TSource> source
)

Type Parameters

  • TSource
    The type of the elements of source.

Parameters

Return Value

Type: System.Collections.Generic.IEnumerable<TSource>
An IEnumerable<T> that contains distinct elements from the source sequence.

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.

Exceptions

Exception Condition
ArgumentNullException

source is nulla null reference (Nothing in Visual Basic).

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 Visual C# or For Each in Visual Basic.

The Distinct<TSource>(IEnumerable<TSource>) method returns an unordered sequence that contains no duplicate values. It uses the default equality comparer, Default, to compare values.

In Visual Basic query expression syntax, a Distinct clause translates to an invocation of Distinct.

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.

Examples

The following code example demonstrates how to use Distinct<TSource>(IEnumerable<TSource>) to return distinct elements from a sequence of integers.

      ' Create a list of integers.
      Dim ages As New List(Of Integer)(New Integer() _
                                       {21, 46, 46, 55, 17, 21, 55, 55})

      ' Select the unique numbers in the List.
      Dim distinctAges As IEnumerable(Of Integer) = ages.Distinct()

      Dim output As New System.Text.StringBuilder("Distinct ages:" & vbCrLf)
      For Each age As Integer In distinctAges
         output.AppendLine(age)
      Next

      ' Display the output.
      outputBlock.Text &= output.ToString() & vbCrLf

      ' This code produces the following output:
      '
      ' Distinct ages:
      ' 21
      ' 46
      ' 55
      ' 17


      List<int> ages = new List<int> { 21, 46, 46, 55, 17, 21, 55, 55 };

      IEnumerable<int> distinctAges = ages.Distinct();

      outputBlock.Text += "Distinct ages:" + "\n";

      foreach (int age in distinctAges)
      {
         outputBlock.Text += age + "\n";
      }

      /*
       This code produces the following output:

       Distinct ages:
       21
       46
       55
       17
      */

If you want to return distinct elements from sequences of objects of some custom data type, you have to implement the IEqualityComparer<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 Property Name As String
    Public Property 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 hash code for the Name field if it is not null.
        Dim hashProductName = If(Name Is Nothing, 0, Name.GetHashCode())

        ' Get 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


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

    public bool Equals(Product other)
    {

        //Check whether the compared object is null.
        if (Object.ReferenceEquals(other, null)) return false;

        //Check whether the compared object references the same data.
        if (Object.ReferenceEquals(this, other)) return true;

        //Check whether the products' properties are equal.
        return Code.Equals(other.Code) && Name.Equals(other.Name);
    }

    // If Equals() returns true for a pair of objects 
    // then GetHashCode() must return the same value for these objects.

    public override int GetHashCode()
    {

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

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

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

After you implement this interface, you can use a sequence of Product objects in the Distinct<TSource>(IEnumerable<TSource>) method, as shown in the following example.


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

' Exclude duplicates.

Dim noduplicates = products.Distinct()

For Each product In noduplicates
    outputBlock.Text &= product.Name & " " & product.Code.ToString() & vbCrLf
Next
' This code produces the following output:
'
' apple 9
' orange 4
' lemon 12
' 

Product[] products = { new Product { Name = "apple", Code = 9 }, 
                       new Product { Name = "orange", Code = 4 }, 
                       new Product { Name = "apple", Code = 9 }, 
                       new Product { Name = "lemon", Code = 12 } };

//Exclude duplicates.

IEnumerable<Product> noduplicates =
    products.Distinct();

foreach (var product in noduplicates)
    outputBlock.Text += product.Name + " " + product.Code + "\n";

/*
    This code produces the following output:
    apple 9 
    orange 4
    lemon 12
*/

Version Information

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

Platforms

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