IStructuralEquatable IStructuralEquatable IStructuralEquatable IStructuralEquatable Interface

Definition

Definiert Methoden zur Unterstützung der strukturellen Gleichheitsüberprüfung von Objekten.Defines methods to support the comparison of objects for structural equality.

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

Beispiele

Der Standard Gleichheits Vergleich, EqualityComparer<Object>.Default.Equals, berücksichtigt zwei NaN-Werte, die gleich sind.The default equality comparer, EqualityComparer<Object>.Default.Equals, considers two NaN values to be equal. In einigen Fällen möchten Sie jedoch möglicherweise, dass der Vergleich von NaN-Werten auf Gleichheit false zurückgibt. Dies bedeutet, dass die Werte nicht verglichen werden können.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. Im folgenden Beispiel wird eine NanComparer -Klasse definiert, die die IEqualityComparer -Schnittstelle implementiert.The following example defines a NanComparer class that implements the IEqualityComparer interface. Sie wird vom dritten Beispiel als Argument für die Equals(Object, IEqualityComparer)-Methode der IStructuralEquatable-Schnittstelle verwendet, die von Tupeln implementiert wird.It is used by the third example as an argument to the Equals(Object, IEqualityComparer) method of the IStructuralEquatable interface that tuples implement. Er vergleicht zwei Double-oder zwei Single-Werte mithilfe des Gleichheits Operators.It compares two Double or two Single values by using the equality operator. Sie übergibt Werte eines beliebigen anderen Typs an den Standard Gleichheits Vergleich.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

Im folgenden Beispiel werden zwei identische 3-Tupel-Objekte erstellt, deren Komponenten aus drei Double-Werten bestehen.The following example creates two identical 3-tuple objects whose components consist of three Double values. Der Wert der zweiten Komponente ist Double.NaN.The value of the second component is Double.NaN. Im Beispiel wird dann die Tuple<T1,T2,T3>.Equals-Methode aufgerufen, und die IStructuralEquatable.Equals-Methode wird dreimal aufgerufen.The example then calls the Tuple<T1,T2,T3>.Equals method, and it calls the IStructuralEquatable.Equals method three times. Beim ersten Mal übergibt Sie den Standard Gleichheits Vergleich, der von der EqualityComparer<T>.Default-Eigenschaft zurückgegeben wird.The first time, it passes the default equality comparer that is returned by the EqualityComparer<T>.Default property. Beim zweiten Mal übergibt Sie den Standard Gleichheits Vergleich, der von der StructuralComparisons.StructuralEqualityComparer-Eigenschaft zurückgegeben wird.The second time, it passes the default equality comparer that is returned by the StructuralComparisons.StructuralEqualityComparer property. Beim dritten Mal übergibt Sie das benutzerdefinierte NanComparer-Objekt.The third time, it passes the custom NanComparer object. Wie die Ausgabe des Beispiels zeigt, werden die ersten drei Methodenaufrufe true zurückgegeben, während der vierte Aufruf false zurückgibt.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

Hinweise

Struktur Gleichheit bedeutet, dass zwei Objekte gleich sind, da Sie gleiche Werte aufweisen.Structural equality means that two objects are equal because they have equal values. Sie unterscheidet sich von der Verweis Gleichheit, was darauf hinweist, dass zwei Objekt Verweise gleich sind, weil Sie auf dasselbe physische Objekt verweisen.It differs from reference equality, which indicates that two object references are equal because they reference the same physical object. Die IStructuralEquatable-Schnittstelle ermöglicht es Ihnen, angepasste Vergleiche zu implementieren, um die Struktur Gleichheit von Auflistungs Objekten zu überprüfen.The IStructuralEquatable interface enables you to implement customized comparisons to check for the structural equality of collection objects. Das heißt, Sie können eine eigene Definition der strukturellen Gleichheit erstellen und angeben, dass diese Definition mit einem Sammlungstyp verwendet werden soll, der die IStructuralEquatable-Schnittstelle annimmt.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. Die-Schnittstelle verfügt über zwei Member: Equals, die auf Gleichheit prüft, indem eine angegebene IEqualityComparer-Implementierung verwendet wird, und GetHashCode, die identische Hashcodes für Objekte zurückgibt, die gleich sind.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.

Hinweis

Die IStructuralEquatable-Schnittstelle unterstützt nur benutzerdefinierte Vergleiche für strukturelle Gleichheit.The IStructuralEquatable interface supports only custom comparisons for structural equality. Die IStructuralComparable-Schnittstelle unterstützt benutzerdefinierte Struktur Vergleiche zum Sortieren und sortieren.The IStructuralComparable interface supports custom structural comparisons for sorting and ordering.

Der .NET Framework stellt außerdem Standard Gleichheits Vergleiche bereit, die von den Eigenschaften EqualityComparer<T>.Default und StructuralComparisons.StructuralEqualityComparer zurückgegeben werden.The .NET Framework also provides default equality comparers, which are returned by the EqualityComparer<T>.Default and StructuralComparisons.StructuralEqualityComparer properties. Weitere Informationen finden Sie unter Beispiel:For more information, see the example.

Die generischen tupelklassen (Tuple<T1>, Tuple<T1,T2>, Tuple<T1,T2,T3> usw.) und die Array-Klasse stellen explizite Implementierungen der IStructuralEquatable-Schnittstelle bereit.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. Durch umwandeln (in C#) oder konvertieren (in Visual Basic) der aktuellen Instanz eines Arrays oder Tupels in einen IStructuralEquatable-Schnittstellen Wert und Bereitstellen der IEqualityComparer-Implementierung als Argument für die Equals-Methode können Sie einen benutzerdefinierten Gleichheits Vergleich für das Array oder Auflistung.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.

Methoden

Equals(Object, IEqualityComparer) Equals(Object, IEqualityComparer) Equals(Object, IEqualityComparer) Equals(Object, IEqualityComparer)

Bestimmt, ob die Struktur eines Objekt und der aktuellen Instanz gleich ist.Determines whether an object is structurally equal to the current instance.

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

Gibt einen Hashcode für die aktuelle Instanz zurück.Returns a hash code for the current instance.

Gilt für:

Siehe auch