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, считает, что два значения 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. Он используется Третьим примером в качестве аргумента для метода Equals(Object, IEqualityComparer) интерфейса IStructuralEquatable, реализующего кортежи.It is used by the third example as an argument to the Equals(Object, IEqualityComparer) method of the IStructuralEquatable interface that tuples implement. Он сравнивает два значения 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

В следующем примере создаются два идентичных объекта трех кортежей, компоненты которых состоят из трех значений 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 и предоставление реализации @no__t 2 в качестве аргумента для метода 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.

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

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