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, считает, что два 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. Он сравнивает два Double или два 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 значения.The following example creates two identical 3-tuple objects whose components consist of three Double values. Значение второго компонента Double.NaN.The value of the second component is Double.NaN. Затем в примере вызывается Tuple<T1,T2,T3>.Equals метод, он вызывает IStructuralEquatable.Equals метод три раза.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. Во второй раз, он передает компаратор по умолчанию, который возвращается StructuralComparisons.StructuralEqualityComparer свойство.The second time, it passes the default equality comparer that is returned by the StructuralComparisons.StructuralEqualityComparer property. Третий раз, он передает пользовательский NanComparer объекта.The third time, it passes the custom NanComparer object. Как видно из примера, первые три метода вызовы будут возвращать true, тогда как четвертый вызов возвращает 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

Комментарии

Структурное равенство означает, что два объекта равны, поскольку они имеют одинаковые значения.Structural equality means that two objects are equal because they have equal values. Он отличается от равенства ссылок, который указывает, что две объектные ссылки равны, так как они ссылаются на один и тот же физический объект.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, который проверяет равенство, используя указанный 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#) или преобразования (в 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.

Применяется к

Дополнительно