IStructuralEquatable IStructuralEquatable IStructuralEquatable IStructuralEquatable Interface

Definition

Definiert Methoden, die den Vergleich von Objekten auf strukturelle Gleichheit unterstützen.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 Standardgleichheitsvergleich EqualityComparer<Object>.Default.Equals, betrachtet zwei NaN Werte gleich sind.The default equality comparer, EqualityComparer<Object>.Default.Equals, considers two NaN values to be equal. In einigen Fällen, Sie sollten jedoch den Vergleich von NaN Werte hinsichtlich ihrer Gleichheit zurückzugebenden false, was 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 IStructuralEquatable -Schnittstelle implementiert.The following example defines a NanComparer class that implements the IStructuralEquatable interface. Es vergleicht zwei Double oder zwei Single Werte mithilfe des Gleichheitsoperators.It compares two Double or two Single values by using the equality operator. Die Werte eines anderen Typs übergeben an den Standardgleichheitsvergleich.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

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

Hinweise

Strukturelle Gleichheit bedeutet, dass zwei Objekte gleich sind, da sie die gleiche Werte aufweisen.Structural equality means that two objects are equal because they have equal values. Es unterscheidet sich vom Verweisgleichheit, was bedeutet, dass zwei Objektverweise gleich sind, da sie die gleiche 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 können Sie benutzerdefinierte Vergleiche zur Überprüfung der strukturellen gleichheitsüberprüfung von Auflistungsobjekten zu implementieren.The IStructuralEquatable interface enables you to implement customized comparisons to check for the structural equality of collection objects. Sie können, also erstellen Sie Ihre eigene Definitionen der strukturellen gleichheitsüberprüfung und gibt an, dass diese Definition mit dem Auflistungstyp verwendet wird, akzeptiert die IStructuralEquatable Schnittstelle.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 testet auf Gleichheit mit einem angegebenen IEqualityComparer -Implementierung und GetHashCode, womit identische Hashcodes für Objekte, 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 auf Strukturgleichheit überprüft.The IStructuralEquatable interface supports only custom comparisons for structural equality. Die IStructuralComparable Schnittstelle unterstützt benutzerdefinierte strukturelle Vergleiche für das Sortieren und zu sortieren.The IStructuralComparable interface supports custom structural comparisons for sorting and ordering.

Die .NET Framework stellt auch Vergleiche auf Gleichheit, die von zurückgegeben werden die EqualityComparer<T>.Default und StructuralComparisons.StructuralEqualityComparer Eigenschaften.The .NET Framework also provides default equality comparers, which are returned by the EqualityComparer<T>.Default and StructuralComparisons.StructuralEqualityComparer properties. Weitere Informationen finden Sie im Beispiel.For more information, see the example.

Die generische Tuple-Klassen (Tuple<T1>, Tuple<T1,T2>, Tuple<T1,T2,T3>usw.) und die Array Klasse bereitstellen, explizite Implementierungen von der IStructuralEquatable Schnittstelle.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 Umwandlung (in c#) oder konvertieren (in Visual Basic) der aktuellen Instanz eines Arrays oder das Tupel mit einer IStructuralEquatable Schnittstelle Wert und Ihrer IEqualityComparer Implementierung als Argument an die Equals -Methode, können Sie eine benutzerdefinierte Gleichheit definieren Prüfung auf das Array oder einer 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