Defines methods to support the comparison of objects for equality.
Assembly: mscorlib (in mscorlib.dll)
Public Interface IEqualityComparer(Of In T)
public interface IEqualityComparer<in T>
generic<typename T>
public interface class IEqualityComparer
type IEqualityComparer<'T> = interface end
Type Parameters
- T
The type of objects to compare.
This type parameter is contravariant. That is, you can use either the type you specified or any type that is less derived. For more information about covariance and contravariance, see Covariance and Contravariance in Generics.
The IEqualityComparerT type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | Equals | Determines whether the specified objects are equal. |
![]() | GetHashCode | Returns a hash code for the specified object. |
This interface allows the implementation of customized equality comparison for collections. That is, you can create your own definition of equality for type T, and specify that this definition be used with a collection type that accepts the IEqualityComparerT generic interface. In the .NET Framework, constructors of the DictionaryTKey, TValue generic collection type accept this interface.
A default implementation of this interface is provided by the Default property of the EqualityComparerT generic class. The StringComparer class implements IEqualityComparerT of type String.
This interface supports only equality comparisons. Customization of comparisons for sorting and ordering is provided by the IComparerT generic interface.
We recommend that you derive from the EqualityComparerT class instead of implementing the IEqualityComparerT interface, because the EqualityComparerT class tests for equality using the IEquatableTEquals method instead of the ObjectEquals method. This is consistent with the Contains, IndexOf, LastIndexOf, and Remove methods of the DictionaryTKey, TValue class and other generic collections.
The following example adds custom Box objects to a dictionary collection. The Box objects are considered equal if their dimensions are the same.
Imports System
Imports System.Collections.Generic
Class Example
Public Shared Sub Main()
Try
Dim boxEqC As New BoxEqualityComparer()
Dim boxes As Dictionary(Of Box, [String]) = _
New Dictionary(Of Box, String)(boxEqC)
Dim redBox As New Box(4, 3, 4)
Dim blueBox As New Box(4, 3, 4)
boxes.Add(redBox, "red")
boxes.Add(blueBox, "blue")
Catch argEx As ArgumentException
Console.WriteLine(argEx.Message)
End Try
End Sub
End Class
Public Class Box
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
Private _Height As Integer
Public Property Height() As Integer
Get
Return _Height
End Get
Set(ByVal value As Integer)
_Height = value
End Set
End Property
Private _Length As Integer
Public Property Length() As Integer
Get
Return _Length
End Get
Set(ByVal value As Integer)
_Length = value
End Set
End Property
Private _Width As Integer
Public Property Width() As Integer
Get
Return _Width
End Get
Set(ByVal value As Integer)
_Width = value
End Set
End Property
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.Height = b2.Height And b1.Length = _
b2.Length And 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
using System;
using System.Collections.Generic;
class Example
{
static void Main()
{
try
{
BoxEqualityComparer boxEqC = new BoxEqualityComparer();
Dictionary<Box, String> boxes = new Dictionary<Box,
string>(boxEqC);
Box redBox = new Box(4, 3, 4);
Box blueBox = new Box(4, 3, 4);
boxes.Add(redBox, "red");
boxes.Add(blueBox, "blue");
Console.WriteLine(redBox.GetHashCode());
Console.WriteLine(blueBox.GetHashCode());
}
catch (ArgumentException argEx)
{
Console.WriteLine(argEx.Message);
}
}
}
public class Box
{
public Box(int h, int l, int w)
{
this.Height = h;
this.Length = l;
this.Width = w;
}
public int Height { get; set; }
public int Length { get; set; }
public int Width { get; set; }
}
class BoxEqualityComparer : IEqualityComparer<Box>
{
public bool Equals(Box b1, Box b2)
{
if (b1.Height == b2.Height & b1.Length == b2.Length
& b1.Width == b2.Width)
{
return true;
}
else
{
return false;
}
}
public int GetHashCode(Box bx)
{
int hCode = bx.Height ^ bx.Length ^ bx.Width;
return hCode.GetHashCode();
}
}
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.png)