IStructuralEquatable Interfejs

Definicja

Definiuje metody do obsługi porównania obiektów pod kątem równości strukturalnej.Defines methods to support the comparison of objects for structural equality.

public interface class IStructuralEquatable
public interface IStructuralEquatable
type IStructuralEquatable = interface
Public Interface IStructuralEquatable
Pochodne

Przykłady

Domyślna funkcja porównująca równość, EqualityComparer<Object>.Default.Equals, uwzględnia dwa NaN wartości jako równe.The default equality comparer, EqualityComparer<Object>.Default.Equals, considers two NaN values to be equal. Jednak w niektórych przypadkach możesz chcieć porównać wartości NaN dla opcji równość do zwrócenia false, co oznacza, że wartości nie mogą być porównywane.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. W poniższym przykładzie zdefiniowano klasę NanComparer implementującą interfejs IEqualityComparer.The following example defines a NanComparer class that implements the IEqualityComparer interface. Jest on używany przez trzeci przykład jako argument metody Equals(Object, IEqualityComparer) interfejsu IStructuralEquatable, który implementuje krotki.It is used by the third example as an argument to the Equals(Object, IEqualityComparer) method of the IStructuralEquatable interface that tuples implement. Porównuje dwie Double lub dwie wartości Single przy użyciu operatora równości.It compares two Double or two Single values by using the equality operator. Przekazuje ona wartości dowolnego innego typu do domyślnej opcji porównującej równość.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

Poniższy przykład tworzy dwa identyczne obiekty typu krotka, których składniki składają się z trzech Double wartości.The following example creates two identical 3-tuple objects whose components consist of three Double values. Wartość drugiego składnika jest Double.NaN.The value of the second component is Double.NaN. Przykład następnie wywołuje metodę Tuple<T1,T2,T3>.Equals i wywołuje metodę IStructuralEquatable.Equals trzykrotnie.The example then calls the Tuple<T1,T2,T3>.Equals method, and it calls the IStructuralEquatable.Equals method three times. Po raz pierwszy przekazuje domyślną funkcję porównującą równość zwracaną przez właściwość EqualityComparer<T>.Default.The first time, it passes the default equality comparer that is returned by the EqualityComparer<T>.Default property. Drugi raz przekazuje domyślną funkcję porównującą równość zwracaną przez właściwość StructuralComparisons.StructuralEqualityComparer.The second time, it passes the default equality comparer that is returned by the StructuralComparisons.StructuralEqualityComparer property. Trzeci czas przejdzie do niestandardowego obiektu NanComparer.The third time, it passes the custom NanComparer object. Jako dane wyjściowe z przykładu pokazuje pierwsze trzy metody wywołania zwraca true, podczas gdy czwarte wywołanie zwraca 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

Uwagi

Równość strukturalna oznacza, że dwa obiekty są równe, ponieważ mają równe wartości.Structural equality means that two objects are equal because they have equal values. Różni się od równości odwołań, co oznacza, że dwa odwołania do obiektów są równe, ponieważ odwołują się do tego samego obiektu fizycznego.It differs from reference equality, which indicates that two object references are equal because they reference the same physical object. Interfejs IStructuralEquatable pozwala zaimplementować dostosowane porównania, aby sprawdzić, czy strukturalne równość obiektów kolekcji.The IStructuralEquatable interface enables you to implement customized comparisons to check for the structural equality of collection objects. Oznacza to, że można utworzyć własną definicję równości strukturalnej i określić, że ta definicja będzie używana z typem kolekcji akceptującym interfejs 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. Interfejs ma dwa elementy członkowskie: Equals, które sprawdzają równość przy użyciu określonej IEqualityComparer implementacji, i GetHashCode, która zwraca identyczne kody skrótów dla obiektów, które są równe.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.

Uwaga

Interfejs IStructuralEquatable obsługuje tylko niestandardowe porównania dla równości strukturalnej.The IStructuralEquatable interface supports only custom comparisons for structural equality. Interfejs IStructuralComparable obsługuje niestandardowe porównania strukturalne na potrzeby sortowania i porządkowania.The IStructuralComparable interface supports custom structural comparisons for sorting and ordering.

.NET Framework udostępnia również domyślne funkcje porównujące równość, które są zwracane przez właściwości EqualityComparer<T>.Default i StructuralComparisons.StructuralEqualityComparer.The .NET Framework also provides default equality comparers, which are returned by the EqualityComparer<T>.Default and StructuralComparisons.StructuralEqualityComparer properties. Aby uzyskać więcej informacji, zobacz przykład.For more information, see the example.

Klasy kolekcji generycznej (Tuple<T1>, Tuple<T1,T2>, Tuple<T1,T2,T3>itd.) i Klasa Array zapewniają jawne implementacje interfejsu 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. Przez rzutowanie ( C#w) lub konwertowanie (w Visual Basic) bieżące wystąpienie tablicy lub krotki do wartości interfejsu IStructuralEquatable i dostarczając IEqualityComparer implementację jako argument do metody Equals, można zdefiniować niestandardowe porównanie równości dla tablicy lub kolekcji.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.

Metody

Equals(Object, IEqualityComparer)

Określa, czy obiekt jest strukturalnie równy bieżącemu wystąpieniu.Determines whether an object is structurally equal to the current instance.

GetHashCode(IEqualityComparer)

Zwraca kod skrótu dla bieżącego wystąpienia.Returns a hash code for the current instance.

Dotyczy

Zobacz też