Enumerable.Except Método

Definição

Namespace:

System.Linq

Assembly:

System.Linq.dll

Produz a diferença de conjunto de duas sequências.

Sobrecargas

Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>)	Produz a diferença de conjunto de duas sequências usando o comparador de igualdade padrão para comparar os valores.
Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>, IEqualityComparer<TSource>)	Produz a diferença de conjunto de duas sequências usando o IEqualityComparer<T> especificado para comparar os valores.

Comentários

A diferença de conjunto de dois conjuntos é definida como os membros do primeiro conjunto que não aparecem no segundo conjunto.

Esse método retorna esses elementos em first que não aparecem em second. Ele não retorna esses elementos em second que não aparecem em first. Somente elementos exclusivos são retornados.

Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>)

Origem:

Except.cs

Produz a diferença de conjunto de duas sequências usando o comparador de igualdade padrão para comparar os valores.

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

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

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

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

Parâmetros de tipo

TSource

O tipo dos elementos das sequências de entrada.

Parâmetros

first

IEnumerable<TSource>

Um IEnumerable<T> cujos elementos que não estão presentes também no second serão retornados.

second

IEnumerable<TSource>

Um IEnumerable<T> cujos elementos que também ocorrem na primeira sequência farão com que esses elementos sejam removidos da sequência retornada.

Retornos

IEnumerable<TSource>

Uma sequência que contém a diferença de conjunto dos elementos das duas sequências.

Exceções

ArgumentNullException

first ou second é null.

Exemplos

O exemplo de código a seguir demonstra como usar o Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) método para comparar duas sequências de números e retornar elementos que aparecem apenas na primeira sequência.

double[] numbers1 = { 2.0, 2.0, 2.1, 2.2, 2.3, 2.3, 2.4, 2.5 };
double[] numbers2 = { 2.2 };

IEnumerable<double> onlyInFirstSet = numbers1.Except(numbers2);

foreach (double number in onlyInFirstSet)
    Console.WriteLine(number);

/*
 This code produces the following output:

 2
 2.1
 2.3
 2.4
 2.5
*/

' Create two arrays of doubles.
Dim numbers1() As Double = { 2.0, 2.0, 2.1, 2.2, 2.3, 2.3, 2.4, 2.5 }
Dim numbers2() As Double = {2.2}

' Select the elements from the first array that are not
' in the second array.
Dim onlyInFirstSet As IEnumerable(Of Double) = numbers1.Except(numbers2)

Dim output As New System.Text.StringBuilder
For Each number As Double In onlyInFirstSet
    output.AppendLine(number)
Next

' Display the output.
Console.WriteLine(output.ToString())

' This code produces the following output:
'
' 2
' 2.1
' 2.3
' 2.4
' 2.5

Se você quiser comparar sequências de objetos de algum tipo de dados personalizado, será necessário implementar a IEquatable<T> interface genérica em uma classe auxiliar. O exemplo de código a seguir mostra como implementar essa interface em um tipo de dados personalizado e substituir os GetHashCode métodos e Equals .

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

Depois de implementar essa interface, você pode usar sequências de ProductA objetos no Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) método , conforme mostrado no exemplo a seguir:

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

ProductA[] fruits2 = { new ProductA { Name = "apple", Code = 9 } };

// Get all the elements from the first array
// except for the elements from the second array.

IEnumerable<ProductA> except =
    fruits1.Except(fruits2);

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

/*
  This code produces the following output:

  orange 4
  lemon 12
*/

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

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

' Get all the elements from the first array
' except for the elements from the second array.

Dim except = fruits1.Except(fruits2)

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

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

Comentários

Esse método é implementado usando a execução adiada. O valor retornado imediato é um objeto que armazena todas as informações necessárias para executar a ação. A consulta representada por esse método não é executada até que o objeto seja enumerado chamando seu GetEnumerator método diretamente ou usando foreach em C# ou For Each no Visual Basic.

O comparador de igualdade padrão, Default, é usado para comparar valores dos tipos. Para comparar um tipo de dados personalizado, você precisa substituir os EqualsGetHashCode métodos e e, opcionalmente, implementar a IEquatable<T> interface genérica no tipo personalizado. Para obter mais informações, consulte a propriedade Default.

Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>, IEqualityComparer<TSource>)

Origem:

Except.cs

Produz a diferença de conjunto de duas sequências usando o IEqualityComparer<T> especificado para comparar os valores.

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

public static System.Collections.Generic.IEnumerable<TSource> Except<TSource> (this System.Collections.Generic.IEnumerable<TSource> first, System.Collections.Generic.IEnumerable<TSource> second, System.Collections.Generic.IEqualityComparer<TSource>? comparer);

static member Except : seq<'Source> * seq<'Source> * System.Collections.Generic.IEqualityComparer<'Source> -> seq<'Source>

<Extension()>
Public Function Except(Of TSource) (first As IEnumerable(Of TSource), second As IEnumerable(Of TSource), comparer As IEqualityComparer(Of TSource)) As IEnumerable(Of TSource)

Parâmetros de tipo

TSource

O tipo dos elementos das sequências de entrada.

Parâmetros

first

IEnumerable<TSource>

Um IEnumerable<T> cujos elementos que não estão presentes também no second serão retornados.

second

IEnumerable<TSource>

Um IEnumerable<T> cujos elementos que também ocorrem na primeira sequência farão com que esses elementos sejam removidos da sequência retornada.

comparer

IEqualityComparer<TSource>

Um IEqualityComparer<T> para comparar valores.

Retornos

IEnumerable<TSource>

Uma sequência que contém a diferença de conjunto dos elementos das duas sequências.

Exceções

ArgumentNullException

first ou second é null.

Exemplos

Se você quiser comparar sequências de objetos de algum tipo de dados personalizado, será necessário implementar a IEqualityComparer<T> interface genérica em uma classe auxiliar. O exemplo de código a seguir mostra como implementar essa interface em um tipo de dados personalizado e fornecer GetHashCode métodos e Equals . O exemplo a seguir mostra como implementar um comparador de igualdade que pode ser usado no Except método .

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

// Custom comparer for the Product class
class ProductComparer : IEqualityComparer<Product>
{
    // Products are equal if their names and product numbers are equal.
    public bool Equals(Product x, Product y)
    {

        //Check whether the compared objects reference the same data.
        if (Object.ReferenceEquals(x, y)) return true;

        //Check whether any of the compared objects is null.
        if (Object.ReferenceEquals(x, null) || Object.ReferenceEquals(y, null))
            return false;

        //Check whether the products' properties are equal.
        return x.Code == y.Code && x.Name == y.Name;
    }

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

    public int GetHashCode(Product product)
    {
        //Check whether the object is null
        if (Object.ReferenceEquals(product, null)) return 0;

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

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

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

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

Depois de implementar esse comparador, você pode usar sequências de Product objetos no Except método , conforme mostrado no exemplo a seguir:

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

Product[] fruits2 = { new Product { Name = "apple", Code = 9 } };

// Get all the elements from the first array
// except for the elements from the second array.

IEnumerable<Product> except =
    fruits1.Except(fruits2, new ProductComparer());

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

/*
  This code produces the following output:

  orange 4
  lemon 12
*/

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

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

' Get all the elements from the first array
' except for the elements from the second array.

Dim except = fruits1.Except(fruits2, New ProductComparer())

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

' This code produces the following output:
'
' orange 4
' lemon 12

Comentários

Se comparer for null, o comparador de igualdade padrão, Default, será usado para comparar valores.