IStructuralEquatable インターフェイス

定義

オブジェクトの構造が等価かどうかの比較をサポートするメソッドを定義します。Defines methods to support the comparison of objects for structural equality.

public interface class IStructuralEquatable
public interface IStructuralEquatable
type IStructuralEquatable = interface
Public Interface IStructuralEquatable
派生

既定の等値比較子である EqualityComparer<Object>.Default.Equalsでは、2つの NaN 値が等しいと見なされます。The default equality comparer, EqualityComparer<Object>.Default.Equals, considers two NaN values to be equal. ただし、場合によっては、NaN 値の等価性を比較して falseを返すことが必要になることがあります。これは、値を比較できないことを示します。However, in some cases, you may want the comparison of NaN values for equality to return false, which indicates that the values cannot be compared. 次の例では、 NanComparer インターフェイスを実装する IEqualityComparer クラスを定義しています。The following example defines a NanComparer class that implements the IEqualityComparer interface. 3番目の例では、タプルが実装する IStructuralEquatable インターフェイスの Equals(Object, IEqualityComparer) メソッドの引数として使用されます。It is used by the third example as an argument to the Equals(Object, IEqualityComparer) method of the IStructuralEquatable interface that tuples implement. これは、等値演算子を使用して2つの Double または2つの Single 値を比較します。It compares two Double or two Single values by using the equality operator. これは、他の型の値を既定の等値比較子に渡します。It passes values of any other type to the default equality comparer.

using System;
using System.Collections;
using System.Collections.Generic;

public class NanComparer : IEqualityComparer
{
   public new bool Equals(object x, object y)
   {
      if (x is float)
         return (float) x == (float) y;
      else if (x is double)
         return (double) x == (double) y;
      else
         return EqualityComparer<object>.Default.Equals(x, y);
   }
   
   public int GetHashCode(object obj)
   {
      return EqualityComparer<object>.Default.GetHashCode(obj);
   }
}
Imports System.Collections
Imports System.Collections.Generic

Public Class NanComparer : Implements IEqualityComparer
   Public Overloads Function Equals(x As Object, y As Object) As Boolean _
          Implements IEqualityComparer.Equals
      If TypeOf x Is Single Then
         Return CSng(x) = CSng(y)
      ElseIf TypeOf x Is Double Then
         Return CDbl(x) = CDbl(y)
      Else
         Return EqualityComparer(Of Object).Default.Equals(x, y)
      End If
   End Function
   
   Public Overloads Function GetHashCode(obj As Object) As Integer _
          Implements IEqualityComparer.GetHashCode
      Return EqualityComparer(Of Object).Default.GetHashCode(obj)
   End Function
End Class

次の例では、3つの Double 値から構成されるコンポーネントを持つ2つの同一の3タプルオブジェクトを作成します。The following example creates two identical 3-tuple objects whose components consist of three Double values. 2番目のコンポーネントの値は Double.NaNです。The value of the second component is Double.NaN. 次に、Tuple<T1,T2,T3>.Equals メソッドを呼び出し、IStructuralEquatable.Equals メソッドを3回呼び出します。The example then calls the Tuple<T1,T2,T3>.Equals method, and it calls the IStructuralEquatable.Equals method three times. 最初に、EqualityComparer<T>.Default プロパティによって返される既定の等値比較子を渡します。The first time, it passes the default equality comparer that is returned by the EqualityComparer<T>.Default property. 2回目は、StructuralComparisons.StructuralEqualityComparer プロパティによって返される既定の等値比較子を渡します。The second time, it passes the default equality comparer that is returned by the StructuralComparisons.StructuralEqualityComparer property. 3回目は、カスタム NanComparer オブジェクトを渡します。The third time, it passes the custom NanComparer object. この例の出力が示すように、最初の3つのメソッド呼び出しは trueを返し、4番目の呼び出しは falseを返します。As the output from the example shows, the first three method calls return true, whereas the fourth call returns false.

public class Example
{
   public static void Main()
   {
      var t1 = Tuple.Create(12.3, Double.NaN, 16.4);
      var t2 = Tuple.Create(12.3, Double.NaN, 16.4);
      
      // Call default Equals method.
      Console.WriteLine(t1.Equals(t2));
      
      IStructuralEquatable equ = t1;
      // Call IStructuralEquatable.Equals using default comparer.
      Console.WriteLine(equ.Equals(t2, EqualityComparer<object>.Default));
      
      // Call IStructuralEquatable.Equals using 
      // StructuralComparisons.StructuralEqualityComparer.
      Console.WriteLine(equ.Equals(t2, 
                        StructuralComparisons.StructuralEqualityComparer));
      
      // Call IStructuralEquatable.Equals using custom comparer.
      Console.WriteLine(equ.Equals(t2, new NanComparer()));
   }
}
// The example displays the following output:
//       True
//       True
//       True
//       False
Module Example
   Public Sub Main()
      Dim t1 = Tuple.Create(12.3, Double.NaN, 16.4)
      Dim t2 = Tuple.Create(12.3, Double.NaN, 16.4)
      
      ' Call default Equals method.
      Console.WriteLine(t1.Equals(t2))
      
      Dim equ As IStructuralEquatable = t1
      ' Call IStructuralEquatable.Equals using default comparer.
      Console.WriteLine(equ.Equals(t2, EqualityComparer(Of Object).Default))
      
      ' Call IStructuralEquatable.Equals using 
      ' StructuralComparisons.StructuralEqualityComparer.
      Console.WriteLine(equ.Equals(t2, 
                        StructuralComparisons.StructuralEqualityComparer))
      
      ' Call IStructuralEquatable.Equals using custom comparer.
      Console.WriteLine(equ.Equals(t2, New NanComparer))
   End Sub
End Module
' The example displays the following output:
'       True
'       True
'       True
'       False

注釈

構造的等価性とは、2つのオブジェクトが等しい値を持つために等しいことを意味します。Structural equality means that two objects are equal because they have equal values. これは、同じ物理オブジェクトを参照するため、2つのオブジェクト参照が等しいことを示す、参照の等価性とは異なります。It differs from reference equality, which indicates that two object references are equal because they reference the same physical object. IStructuralEquatable インターフェイスを使用すると、コレクションオブジェクトの構造的等価性を確認するためのカスタマイズされた比較を実装できます。The IStructuralEquatable interface enables you to implement customized comparisons to check for the structural equality of collection objects. つまり、構造等値の独自の定義を作成し、この定義を IStructuralEquatable インターフェイスを受け入れるコレクション型と共に使用するように指定できます。That is, you can create your own definition of structural equality and specify that this definition be used with a collection type that accepts the IStructuralEquatable interface. インターフェイスには、Equalsという2つのメンバーがあります。これは、指定された IEqualityComparer 実装を使用して等しいかどうかをテストします。 GetHashCodeは、等しいオブジェクトに対して同一のハッシュコードを返します。The interface has two members: Equals, which tests for equality by using a specified IEqualityComparer implementation, and GetHashCode, which returns identical hash codes for objects that are equal.

注意

IStructuralEquatable インターフェイスでは、構造の等価性のためにカスタム比較のみがサポートされます。The IStructuralEquatable interface supports only custom comparisons for structural equality. IStructuralComparable インターフェイスは、並べ替えと順序付けのためのカスタム構造の比較をサポートしています。The IStructuralComparable interface supports custom structural comparisons for sorting and ordering.

.NET Framework には、EqualityComparer<T>.Default プロパティと StructuralComparisons.StructuralEqualityComparer プロパティによって返される既定の等値比較子も用意されています。The .NET Framework also provides default equality comparers, which are returned by the EqualityComparer<T>.Default and StructuralComparisons.StructuralEqualityComparer properties. 詳細については、例を参照してください。For more information, see the example.

ジェネリックのタプルクラス (Tuple<T1>Tuple<T1,T2>Tuple<T1,T2,T3>など)、Arrayクラスの明示的な実装を提供する、IStructuralEquatableインターフェイス。The generic tuple classes (Tuple<T1>, Tuple<T1,T2>, Tuple<T1,T2,T3>, and so on) and the Array class provide explicit implementations of the IStructuralEquatable interface. 配列または組C#の現在のインスタンスを IStructuralEquatable インターフェイス値にキャスト () または変換 (Visual Basic) し、IEqualityComparer 実装を引数として Equals メソッドに渡すことで、配列またはコレクションのカスタム等値比較を定義できます。By casting (in C#) or converting (in Visual Basic) the current instance of an array or tuple to an IStructuralEquatable interface value and providing your IEqualityComparer implementation as an argument to the Equals method, you can define a custom equality comparison for the array or collection.

メソッド

Equals(Object, IEqualityComparer)

オブジェクトが現在のインスタンスと構造的に等しいかどうかを判断します。Determines whether an object is structurally equal to the current instance.

GetHashCode(IEqualityComparer)

現在のインスタンスのハッシュ コードを返します。Returns a hash code for the current instance.

適用対象

こちらもご覧ください