IEqualityComparer<T> Interface

Définition

Espace de noms:

System.Collections.Generic

Assembly:

System.Runtime.dll

Définit des méthodes pour prendre en charge la comparaison d'objets.

C#

public interface IEqualityComparer<in T>

Paramètres de type

T

Type des objets à comparer.

Ce paramètre de type est contravariant. Cela signifie que vous pouvez utiliser le type spécifié ou tout type moins dérivé. Pour plus d’informations sur la covariance et la contravariance, consultez Covariance et contravariance dans les génériques.

Dérivé

Microsoft.Extensions.Primitives.StringSegmentComparer

System.Collections.Generic.EqualityComparer<T>

System.Collections.Generic.ReferenceEqualityComparer

System.Data.DataRowComparer<TRow>

System.Numerics.TotalOrderIeee754Comparer<T>

System.Reflection.Metadata.HandleComparer

System.StringComparer

System.Xml.Linq.XNodeEqualityComparer

Exemples

L’exemple suivant ajoute des objets personnalisés Box à une collection de dictionnaires. Les Box objets sont considérés comme égaux si leurs dimensions sont les mêmes.

C#

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.

Remarques

Cette interface permet l’implémentation d’une comparaison d’égalité personnalisée pour les collections. Autrement dit, vous pouvez créer votre propre définition d’égalité pour le type Tet spécifier que cette définition doit être utilisée avec un type de collection qui accepte l’interface IEqualityComparer<T> générique. Dans le .NET Framework, les constructeurs du Dictionary<TKey,TValue> type de collection générique acceptent cette interface.

Une implémentation par défaut de cette interface est fournie par la Default propriété de la EqualityComparer<T> classe générique. La StringComparer classe implémente IEqualityComparer<T> de type String.

Cette interface prend uniquement en charge les comparaisons d’égalité. La personnalisation des comparaisons pour le tri et l’ordre est fournie par l’interface IComparer<T> générique.

Nous vous recommandons de dériver de la EqualityComparer<T> classe au lieu d’implémenter l’interface IEqualityComparer<T> , car la EqualityComparer<T> classe teste l’égalité à l’aide de la IEquatable<T>.Equals méthode au lieu de la Object.Equals méthode. Cela est cohérent avec les Containsméthodes , IndexOf, LastIndexOfet Remove de la Dictionary<TKey,TValue> classe et d’autres collections génériques.

Méthodes

Equals(T, T)	Détermine si les objets spécifiés sont égaux.
GetHashCode(T)	Retourne un code de hachage pour l'objet spécifié.

S’applique à

Voir aussi

• EqualityComparer<T>
• Dictionary<TKey,TValue>
• Dictionary<TKey,TValue>
• IComparer<T>