IEqualityComparer<T> Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Definiert Methoden zur Unterstützung der Gleichheitsüberprüfung von Objekten.
generic <typename T>
public interface class IEqualityComparerpublic interface IEqualityComparer<in T>public interface IEqualityComparer<T>type IEqualityComparer<'T> = interfacePublic Interface IEqualityComparer(Of In T)Public Interface IEqualityComparer(Of T)Typparameter
- T
Der Typ der zu vergleichenden Objekte.
Dieser Typparameter ist kontravariant. Das bedeutet, dass Sie entweder den angegebenen Typ oder einen weniger abgeleiteten Typ verwenden können. Weitere Informationen zu Kovarianz und Kontravarianz finden Sie unter Kovarianz und Kontravarianz in Generics.- Abgeleitet
Beispiele
Im folgenden Beispiel werden benutzerdefinierte Box Objekte zu einer Wörterbuchauflistung hinzugefügt. Die Box Objekte gelten als gleich, wenn ihre Dimensionen identisch sind.
using System;
using System.Collections.Generic;
static class Example
{
static void Main()
{
BoxEqualityComparer comparer = new();
Dictionary<Box, string> boxes = new(comparer);
AddBox(new Box(4, 3, 4), "red");
AddBox(new Box(4, 3, 4), "blue");
AddBox(new Box(3, 4, 3), "green");
Console.WriteLine($"The dictionary contains {boxes.Count} Box objects.");
void AddBox(Box box, string name)
{
try
{
boxes.Add(box, name);
}
catch (ArgumentException e)
{
Console.WriteLine($"Unable to add {box}: {e.Message}");
}
}
}
}
class Box
{
public int Height { get; }
public int Length { get; }
public int Width { get; }
public Box(int height, int length, int width)
{
Height = height;
Length = length;
Width = width;
}
public override string ToString() => $"({Height}, {Length}, {Width})";
}
class BoxEqualityComparer : IEqualityComparer<Box>
{
public bool Equals(Box? b1, Box? b2)
{
if (ReferenceEquals(b1, b2))
return true;
if (b2 is null || b1 is null)
return false;
return b1.Height == b2.Height
&& b1.Length == b2.Length
&& b1.Width == b2.Width;
}
public int GetHashCode(Box box) => box.Height ^ box.Length ^ box.Width;
}
// The example displays the following output:
// Unable to add (4, 3, 4): An item with the same key has already been added.
// The dictionary contains 2 Box objects.
Imports System.Collections.Generic
Module Example
Public Sub Main()
Dim boxEqC As New BoxEqualityComparer()
Dim boxes As New Dictionary(Of Box, String)(boxEqC)
Dim redBox = New Box(4, 3, 4)
AddBox(boxes, redBox, "red")
Dim blueBox = new Box(4, 3, 4)
AddBox(boxes, blueBox, "blue")
Dim greenBox = new Box(3, 4, 3)
AddBox(boxes, greenBox, "green")
Console.WriteLine()
Console.WriteLine("The dictionary contains {0} Box objects.",
boxes.Count)
End Sub
Private Sub AddBox(dict As Dictionary(Of Box, String), box As Box, name As String)
Try
dict.Add(box, name)
Catch e As ArgumentException
Console.WriteLine("Unable to add {0}: {1}", box, e.Message)
End Try
End Sub
End Module
Public Class Box
Private _Height As Integer
Private _Length As Integer
Private _Width As Integer
Public Sub New(ByVal h As Integer, ByVal l As Integer,
ByVal w As Integer)
Me.Height = h
Me.Length = l
Me.Width = w
End Sub
Public Property Height() As Integer
Get
Return _Height
End Get
Set(ByVal value As Integer)
_Height = value
End Set
End Property
Public Property Length() As Integer
Get
Return _Length
End Get
Set(ByVal value As Integer)
_Length = value
End Set
End Property
Public Property Width() As Integer
Get
Return _Width
End Get
Set(ByVal value As Integer)
_Width = value
End Set
End Property
Public Overrides Function ToString() As String
Return String.Format("({0}, {1}, {2})", _Height, _Length, _Width)
End Function
End Class
Class BoxEqualityComparer
Implements IEqualityComparer(Of Box)
Public Overloads Function Equals(ByVal b1 As Box, ByVal b2 As Box) _
As Boolean Implements IEqualityComparer(Of Box).Equals
If b1 Is Nothing AndAlso b2 Is Nothing Then
Return True
ElseIf b1 Is Nothing Or b2 Is Nothing Then
Return False
ElseIf b1.Height = b2.Height AndAlso b1.Length =
b2.Length AndAlso b1.Width = b2.Width Then
Return True
Else
Return False
End If
End Function
Public Overloads Function GetHashCode(ByVal bx As Box) _
As Integer Implements IEqualityComparer(Of Box).GetHashCode
Dim hCode As Integer = bx.Height Xor bx.Length Xor bx.Width
Return hCode.GetHashCode()
End Function
End Class
' The example displays the following output:
' Unable to add (4, 3, 4): An item with the same key has already been added.
'
' The dictionary contains 2 Box objects.
Hinweise
Diese Schnittstelle ermöglicht die Implementierung eines benutzerdefinierten Gleichheitsvergleichs für Sammlungen. Das heißt, Sie können Eine eigene Definition der Gleichheit für den Typ Terstellen und angeben, dass diese Definition mit einem Auflistungstyp verwendet wird, der die IEqualityComparer<T> generische Schnittstelle akzeptiert. Im .NET Framework akzeptieren Konstruktoren des Dictionary<TKey,TValue> generischen Auflistungstyps diese Schnittstelle.
Eine Standardimplementierung dieser Schnittstelle wird von der Default Eigenschaft der EqualityComparer<T> generischen Klasse bereitgestellt. Die StringComparer -Klasse implementiert IEqualityComparer<T> den Typ String.
Diese Schnittstelle unterstützt nur Gleichheitsvergleiche. Die Anpassung von Vergleichen zum Sortieren und Sortieren wird über die IComparer<T> generische Schnittstelle bereitgestellt.
Es wird empfohlen, dass Sie von der EqualityComparer<T> -Klasse ableiten, anstatt die IEqualityComparer<T> Schnittstelle zu implementieren, da die EqualityComparer<T> Klasse die Gleichheit mithilfe der IEquatable<T>.Equals -Methode anstelle der Object.Equals -Methode testet. Dies ist konsistent mit den ContainsMethoden , IndexOf, LastIndexOfund Remove der Dictionary<TKey,TValue> -Klasse und anderen generischen Auflistungen.
Methoden
| Equals(T, T) |
Bestimmt, ob die angegebenen Objekte gleich sind. |
| GetHashCode(T) |
Gibt einen Hashcode für das angegebene Objekt zurück. |
