Enumerable.Except Метод

Определение

Пространство имен:

System.Linq

Сборка:

System.Linq.dll

Находит разность множеств, представленных двумя последовательностями.

Перегрузки

Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>)	Находит разность множеств, представленных двумя последовательностями, используя для сравнения значений компаратор проверки на равенство по умолчанию.
Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>, IEqualityComparer<TSource>)	Находит разность множеств, представленных двумя последовательностями, используя для сравнения значений указанный компаратор IEqualityComparer<T>.

Комментарии

Разница в наборе двух наборов определяется как члены первого набора, которые не отображаются во втором наборе.

Этот метод возвращает элементы в first , которые не отображаются в second. Он не возвращает те элементы в second , которые не отображаются в first. Возвращаются только уникальные элементы.

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

Исходный код:

Except.cs

Находит разность множеств, представленных двумя последовательностями, используя для сравнения значений компаратор проверки на равенство по умолчанию.

C#

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

Параметры типа

TSource

Тип элементов входных последовательностей.

Параметры

first

IEnumerable<TSource>

Объект IEnumerable<T>, из которого требуется извлечь элементы, отсутствующие в последовательности second.

second

IEnumerable<TSource>

Последовательность IEnumerable<T>, элементы которой, входящие также в первую последовательность, должны быть исключены из возвращаемой последовательности.

Возвращаемое значение

IEnumerable<TSource>

Последовательность, представляющая собой разность двух последовательностей как множеств.

Исключения

ArgumentNullException

Параметр first или second имеет значение null.

Примеры

В следующем примере кода показано, как использовать Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) метод для сравнения двух последовательностей чисел и возвращаемых элементов, которые отображаются только в первой последовательности.

C#

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
*/

Если вы хотите сравнить последовательности объектов какого-то пользовательского типа данных, необходимо реализовать универсальный IEquatable<T> интерфейс во вспомогательном классе. В следующем примере кода показано, как реализовать этот интерфейс в пользовательском типе GetHashCode данных и переопределить методы и Equals .

C#

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();
}

После реализации этого интерфейса можно использовать последовательности ProductA объектов в методе Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) , как показано в следующем примере:

C#

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
*/

Комментарии

Этот метод реализуется с помощью отложенного выполнения. Немедленно возвращаемое значение — это объект, в котором хранятся все сведения, необходимые для выполнения действия. Запрос, представленный этим методом, не выполняется до тех пор, пока объект не будет перечислен либо путем вызова его GetEnumerator метода напрямую, либо с помощью foreach в C# или For Each в Visual Basic.

Компаратор Defaultравенства по умолчанию используется для сравнения значений типов. Чтобы сравнить пользовательский тип данных, необходимо переопределить Equals методы и GetHashCode и при необходимости реализовать универсальный IEquatable<T> интерфейс в пользовательском типе. Дополнительные сведения см. в описании свойства Default.

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

Исходный код:

Except.cs

Находит разность множеств, представленных двумя последовательностями, используя для сравнения значений указанный компаратор IEqualityComparer<T>.

C#

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);

Параметры типа

TSource

Тип элементов входных последовательностей.

Параметры

first

IEnumerable<TSource>

Объект IEnumerable<T>, из которого требуется извлечь элементы, отсутствующие в последовательности second.

second

IEnumerable<TSource>

Последовательность IEnumerable<T>, элементы которой, входящие также в первую последовательность, должны быть исключены из возвращаемой последовательности.

comparer

IEqualityComparer<TSource>

Компаратор IEqualityComparer<T>, используемый для сравнения значений.

Возвращаемое значение

IEnumerable<TSource>

Последовательность, представляющая собой разность двух последовательностей как множеств.

Исключения

ArgumentNullException

Параметр first или second имеет значение null.

Примеры

Если вы хотите сравнить последовательности объектов какого-то пользовательского типа данных, необходимо реализовать универсальный IEqualityComparer<T> интерфейс во вспомогательном классе. В следующем примере кода показано, как реализовать этот интерфейс в пользовательском типе данных и предоставить GetHashCode методы и Equals . В следующем примере показано, как реализовать компаратор на равенство, который можно использовать в методе Except .

C#

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;
    }
}

После реализации этого средства сравнения можно использовать последовательности Product объектов в методе Except , как показано в следующем примере:

C#

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
*/

Комментарии

Если comparer имеет значение null, для сравнения значений используется компаратор Defaultравенства по умолчанию .