Enumerable.Except メソッド

リファレンス

定義

名前空間:: System.Linq

アセンブリ:: System.Linq.dll

アセンブリ:: System.Core.dll

アセンブリ:: netstandard.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

ソース:: Except.cs

ソース:: Except.cs

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

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)

型パラメーター

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 つの数値シーケンスを比較し、最初のシーケンスにのみ表示される要素を返す方法を示します。

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

カスタムデータ型のオブジェクトのシーケンスを比較する場合は、ヘルパークラスにジェネリックインターフェイスを IEquatable<T> 実装する必要があります。次のコード例は、このインターフェイスをカスタムデータ型に実装し、メソッドと Equals メソッドをオーバーライドする方法をGetHashCode示しています。

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

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

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

注釈

このメソッドは、遅延実行を使用して実装されます。即時戻り値は、アクションの実行に必要なすべての情報を格納するオブジェクトです。このメソッドで表されるクエリは、オブジェクトがメソッドを直接呼び出GetEnumeratorすか、C# または For Each Visual Basic でを使用foreachして列挙されるまで実行されません。

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

適用対象

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

ソース:: Except.cs

ソース:: Except.cs

ソース:: Except.cs

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

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

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)

型パラメーター

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 示しています。

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

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

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

注釈

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

適用対象

次の方法で共有

Enumerable.Except メソッド

定義

オーバーロード

注釈

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

型パラメーター

パラメーター

戻り値

例外

例

注釈

適用対象

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

型パラメーター

パラメーター

戻り値

例外

例

注釈

適用対象

その他のリソース