IEqualityComparer<T> インターフェイス

リファレンス

定義

名前空間:: System.Collections.Generic

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

アセンブリ:: mscorlib.dll

アセンブリ:: netstandard.dll

重要

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

オブジェクトの等価比較をサポートするメソッドを定義します。

generic <typename T>
public interface class IEqualityComparer

public interface IEqualityComparer<in T>

public interface IEqualityComparer<T>

type IEqualityComparer<'T> = interface

Public Interface IEqualityComparer(Of In T)

Public Interface IEqualityComparer(Of T)

型パラメーター

T

比較するオブジェクトの型。

この型パラメーターは反変です。つまり、指定した型、または弱い派生型のいずれかを使用することができます。共変性および反変性の詳細については、「ジェネリックの共変性と反変性」をご覧ください。

派生: Microsoft.Extensions.Primitives.StringSegmentComparer

System.Collections.Generic.EqualityComparer<T>

System.Collections.Generic.ReferenceEqualityComparer

System.Data.DataRowComparer<TRow>

System.Numerics.TotalOrderIeee754Comparer<T>

その他…

例

次の例では、ディクショナリコレクションにカスタム Box オブジェクトを追加します。寸法が Box 同じ場合、オブジェクトは等しいと見なされます。

using System;
using System.Collections.Generic;

class Example
{
   static void Main()
   {
      BoxEqualityComparer boxEqC = new BoxEqualityComparer();

      var boxes = new Dictionary<Box, string>(boxEqC);

      var redBox = new Box(4, 3, 4);
      AddBox(boxes, redBox, "red");

      var blueBox = new Box(4, 3, 4);
      AddBox(boxes, blueBox, "blue");

      var greenBox = new Box(3, 4, 3);
      AddBox(boxes, greenBox, "green");
      Console.WriteLine();

      Console.WriteLine("The dictionary contains {0} Box objects.",
                        boxes.Count);
   }

   private static void AddBox(Dictionary<Box, String> dict, Box box, String name)
   {
      try {
         dict.Add(box, name);
      }
      catch (ArgumentException e) {
         Console.WriteLine("Unable to add {0}: {1}", box, e.Message);
      }
   }
}

public class Box
{
    public Box(int h,  int l, int w)
    {
        this.Height = h;
        this.Length = l;
        this.Width = w;
    }

    public int Height { get; set; }
    public int Length { get; set; }
    public int Width { get; set; }

    public override String ToString()
    {
       return String.Format("({0}, {1}, {2})", Height, Length, Width);
    }
}

class BoxEqualityComparer : IEqualityComparer<Box>
{
    public bool Equals(Box b1, Box b2)
    {
        if (b2 == null && b1 == null)
           return true;
        else if (b1 == null || b2 == null)
           return false;
        else if(b1.Height == b2.Height && b1.Length == b2.Length
                            && b1.Width == b2.Width)
            return true;
        else
            return false;
    }

    public int GetHashCode(Box bx)
    {
        int hCode = bx.Height ^ bx.Length ^ bx.Width;
        return hCode.GetHashCode();
    }
}
// The example displays the following output:
//    Unable to add (4, 3, 4): An item with the same key has already been added.
//
//    The dictionary contains 2 Box objects.

Imports System.Collections.Generic

Module Example
   Public Sub Main()

      Dim boxEqC As New BoxEqualityComparer()

      Dim boxes As New Dictionary(Of Box, String)(boxEqC)

      Dim redBox = New Box(4, 3, 4)
      AddBox(boxes, redBox, "red")

      Dim blueBox = new Box(4, 3, 4)
      AddBox(boxes, blueBox, "blue")

      Dim greenBox = new Box(3, 4, 3)
      AddBox(boxes, greenBox, "green")
      Console.WriteLine()

      Console.WriteLine("The dictionary contains {0} Box objects.",
                        boxes.Count)
   End Sub

   Private Sub AddBox(dict As Dictionary(Of Box, String), box As Box, name As String)
      Try
         dict.Add(box, name)
      Catch e As ArgumentException
         Console.WriteLine("Unable to add {0}: {1}", box, e.Message)
      End Try
   End Sub
End Module

Public Class Box
    Private _Height As Integer
    Private _Length As Integer
    Private _Width As Integer

    Public Sub New(ByVal h As Integer, ByVal l As Integer,
                                        ByVal w As Integer)
        Me.Height = h
        Me.Length = l
        Me.Width = w
    End Sub

    Public Property Height() As Integer
        Get
            Return _Height
        End Get
        Set(ByVal value As Integer)
            _Height = value
        End Set
    End Property

    Public Property Length() As Integer
        Get
            Return _Length
        End Get
        Set(ByVal value As Integer)
            _Length = value
        End Set
    End Property

    Public Property Width() As Integer
        Get
            Return _Width
        End Get
        Set(ByVal value As Integer)
            _Width = value
        End Set
    End Property

    Public Overrides Function ToString() As String
       Return String.Format("({0}, {1}, {2})", _Height, _Length, _Width)
    End Function
End Class

Class BoxEqualityComparer
    Implements IEqualityComparer(Of Box)

    Public Overloads Function Equals(ByVal b1 As Box, ByVal b2 As Box) _
                   As Boolean Implements IEqualityComparer(Of Box).Equals

        If b1 Is Nothing AndAlso b2 Is Nothing Then
            Return True
        ElseIf b1 Is Nothing Or b2 Is Nothing Then
            Return False
        ElseIf b1.Height = b2.Height AndAlso b1.Length =
                b2.Length AndAlso b1.Width = b2.Width Then
            Return True
        Else
            Return False
        End If
    End Function

    Public Overloads Function GetHashCode(ByVal bx As Box) _
                As Integer Implements IEqualityComparer(Of Box).GetHashCode
        Dim hCode As Integer = bx.Height Xor bx.Length Xor bx.Width
        Return hCode.GetHashCode()
    End Function

End Class
' The example displays the following output:
'    Unable to add (4, 3, 4): An item with the same key has already been added.
'
'    The dictionary contains 2 Box objects.

注釈

このインターフェイスを使用すると、コレクションのカスタマイズされた等価比較を実装できます。つまり、型 Tの等価性の独自の定義を作成し、ジェネリックインターフェイスを受け入れるコレクション型でこの定義を IEqualityComparer<T> 使用することを指定できます。 .NET Frameworkでは、ジェネリックコレクション型のコンストラクターはこのインターフェイスをDictionary<TKey,TValue>受け入れます。

このインターフェイスの既定の実装は、ジェネリッククラスの EqualityComparer<T> プロパティによってDefault提供されます。クラスは StringComparer 型のを実装しますIEqualityComparer<T>String。

このインターフェイスでは、等価比較のみがサポートされます。並べ替えと順序付けの比較のカスタマイズは、ジェネリックインターフェイスによって IComparer<T> 提供されます。

クラスは、メソッドではなくメソッドをEqualityComparer<T>使用してIEquatable<T>.Equals等価性をIEqualityComparer<T>テストするため、インターフェイスをEqualityComparer<T>実装する代わりに Object.Equals クラスから派生することをお勧めします。これは、クラスおよび他のContainsジェネリックコレクションの Dictionary<TKey,TValue> 、IndexOf、LastIndexOf、および Remove メソッドと一致します。

メソッド

Equals(T, T)	指定したオブジェクトが等しいかどうかを判断します。
GetHashCode(T)	指定したオブジェクトのハッシュコードを返します。

適用対象

IEqualityComparer<T> インターフェイス

定義

型パラメーター

例

注釈

メソッド

適用対象

こちらもご覧ください

その他のリソース