Enumerable.Except メソッド

定義

名前空間:

System.Linq

アセンブリ:

System.Linq.dll

2 つのシーケンスの差集合を生成します。

オーバーロード

Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>)	既定の等値比較子を使用して値を比較することにより、2 つのシーケンスの差集合を生成します。
Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>, IEqualityComparer<TSource>)	指定された IEqualityComparer<T> を使用して値を比較することにより、2 つのシーケンスの差集合を生成します。

注釈

2 つのセットのセット差は、2 番目のセットに表示されない最初のセットのメンバーとして定義されます。

このメソッドは、 に表示されない の first 要素を返します second。 に表示firstされない 内のsecond要素は返されません。 一意の要素のみが返されます。

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

ソース:

Except.cs

既定の等値比較子を使用して値を比較することにより、2 つのシーケンスの差集合を生成します。

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>

second には含まれていないが、返される要素を含む IEnumerable<T>。

second

IEnumerable<TSource>

最初のシーケンスにも含まれ、返されたシーケンスからは削除される要素を含む IEnumerable<T>。

戻り値

IEnumerable<TSource>

2 つのシーケンスの要素の差集合が格納されているシーケンス。

例外

ArgumentNullException

first または second が null です。

例

次のコード例では、 メソッドを Except<TSource>(IEnumerable<TSource>, IEnumerable<TSource>) 使用して 2 つの数値シーケンスを比較し、最初のシーケンスにのみ表示される要素を返す方法を示します。

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> 実装する必要があります。 次のコード例は、このインターフェイスをカスタム データ型に実装し、 メソッドと Equals メソッドをオーバーライドする方法をGetHashCode示しています。

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

このインターフェイスを実装した後、次の例に示すように、 メソッドでExcept<TSource>(IEnumerable<TSource>, IEnumerable<TSource>)オブジェクトのProductAシーケンスを使用できます。

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すか、C# または For Each Visual Basic で を使用foreachして列挙されるまで実行されません。

型の値を比較するには、 Default既定の等値比較子 ( ) が使用されます。 カスタム データ型を比較するには、 メソッドと GetHashCode メソッドをオーバーライドEqualsし、必要に応じてカスタム型にIEquatable<T>ジェネリック インターフェイスを実装する必要があります。 詳細については、Default プロパティを参照してください。

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

ソース:

Except.cs

指定された IEqualityComparer<T> を使用して値を比較することにより、2 つのシーケンスの差集合を生成します。

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>

second には含まれていないが、返される要素を含む IEnumerable<T>。

second

IEnumerable<TSource>

最初のシーケンスにも含まれ、返されたシーケンスからは削除される要素を含む IEnumerable<T>。

comparer

IEqualityComparer<TSource>

値を比較する IEqualityComparer<T>。

戻り値

IEnumerable<TSource>

2 つのシーケンスの要素の差集合が格納されているシーケンス。

例外

ArgumentNullException

first または second が null です。

例

カスタム データ型のオブジェクトのシーケンスを比較する場合は、ヘルパー クラスにジェネリック インターフェイスを IEqualityComparer<T> 実装する必要があります。 次のコード例は、このインターフェイスをカスタム データ型に実装し、 メソッドと Equals メソッドを提供GetHashCodeする方法を示しています。 次の例は、 メソッドで使用できる等値比較子を実装する方法を 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;
    }
}

この比較子を実装した後、次の例に示すように、 メソッドでExceptオブジェクトのProductシーケンスを使用できます。

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

注釈

が nullの場合comparer、値の比較には既定の等値比較子 Defaultが使用されます。