IStructuralEquatable IStructuralEquatable IStructuralEquatable IStructuralEquatable Interface

定義

オブジェクトの構造が等価かどうかの比較をサポートするメソッドを定義します。 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 インターフェイスを実装する IStructuralEquatable クラスを定義しています。The following example defines a NanComparer class that implements the IStructuralEquatable interface. 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 つの構成要素、2 つの同一の 3 組オブジェクトを作成します。Double値。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 つのメソッド呼び出しを返す、出力の例に示すようtrue4 番目の呼び出しが返されますが、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. インターフェイスが 2 つのメンバーには:Equalsを使用して、指定して、等しいかどうかをテスト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>.DefaultStructuralComparisons.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#) または (Visual Basic) では、配列または組の現在のインスタンスに変換して、IStructuralEquatableインターフェイスの値を提供して、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) Equals(Object, IEqualityComparer) Equals(Object, IEqualityComparer) Equals(Object, IEqualityComparer)

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

GetHashCode(IEqualityComparer) GetHashCode(IEqualityComparer) GetHashCode(IEqualityComparer) GetHashCode(IEqualityComparer)

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

適用対象

こちらもご覧ください