5. Сравнение для выяснения равенства
Платформа .NET и язык C# предлагают несколько стандартных протоколов для выяснения равенства объектов. Наиболее общий подход при реализации проверки равенства заключается в переопределении виртуального метода Equals() класса Object. Базовая версия этого метода использует равенство ссылок. Тип ValueType перекрывает Equals(), чтобы реализовать равенство по значению, то есть проверку на совпадение всех соответствующих полей двух переменных типа значения.
Основными причинами перекрытия Equals() в пользовательском типе являются особая семантика равенства, перенос на ссылочный тип равенства по значению, необходимость ускорения проверки на равенство для типа значения. Перекрытая версия Equals() должна удовлетворять следующим требованиям:
1.x.Equals(x) == true.
2.x.Equals(y) == y.Equals(x).
3.(x.Equals(y) && y.Equals(z)) == true ↔ x.Equals(z) == true.
4.Вызовы x.Equals(y) возвращают одинаковое значение до тех пор, пока x
иy остаются неизменными.
5.x.Equals(null) == false, если x != null.
6.Метод Equals() не должен генерировать исключений.
Так как метод Equals() класса Object принимает в качестве аргумента объект, для типов значений при вызове метода происходит операция упаковки. Чтобы избежать этого, тип может дополнительно к перекрытию Equals() реализовать интерфейс IEquatable<T>:
public interface IEquatable<T>
{
bool Equals(T other);
}
Рассмотрим пример неизменяемой структуры Area, в которой выполнено перекрытие метода Equals(), реализация интерфейса IEquatable<T> и перекрытие операций проверки равенства.
public struct Area : IEquatable<Area>
{
public readonly int Measure1; public readonly int Measure2;
public Area(int m1, int m2)
{
Measure1 = Math.Min(m1, m2); Measure2 = Math.Max(m1, m2);
}
public override bool Equals(object other)
{
16
if (other is Area)
{
return Equals((Area) other);
}
return false;
//альтернативная реализация (подходит для типов значений)
//Area? otherArea = other as Area?;
//return otherArea.HasValue && Equals(otherArea.Value);
} |
|
public bool Equals(Area other) |
// реализация IEquatable<Area> |
{ |
|
return Measure1 == other.Measure1 && Measure2 == other.Measure2;
}
public override int GetHashCode()
{
return Measure1 * 31 + Measure2;
}
public static bool operator ==(Area a1, Area a2)
{
return a1.Equals(a2);
}
public static bool operator !=(Area a1, Area a2)
{
return !a1.Equals(a2);
}
}
Базовые типы значений платформы .NET (включая структуры для представления времени) реализуют интерфейс IEquatable<T> и перекрывают операции == и !=. Тип string дополнительно содержит перегруженную версию Equals(), позволяющую выполнить сравнение, учитывающее региональные стандарты или нечувствительное к регистру. Эта версия принимает в качестве аргумента один из элементов перечисления StringComparison:
CurrentCulture – сравнение в алфавите текущего регионального стандарта; CurrentCultureIgnoreCase – сравнение в алфавите текущего регионального
стандарта без учёта регистра символов;
InvariantCulture – сравнение в алфавите инвариантной культуры; InvariantCultureIgnoreCase – сравнение в алфавите инвариантной культу-
ры без учёта регистра;
Ordinal – порядковое сравнение, при котором символы интерпретируются как числа (коды в UTF-16);
OrdinalIgnoreCase – порядковое сравнение без учёта регистра.
17
Если создатель типа не реализовал эффективный метод проверки равенства, этот недостаток можно восполнить, применив подходящий подключаемый
интерфейс. Интерфейсы System.Collections.Generic.IEqualityComparer<T> и System.Collections.IEqualityComparer позволяют организовать проверку объ-
ектов на равенство и вычисление хэш-кода объекта:
public interface IEqualityComparer
{
bool Equals(object x, object y); int GetHashCode(object obj);
}
public interface IEqualityComparer<in T>
{
bool Equals(T x, T y); int GetHashCode(T obj);
}
Желательно, чтобы во вспомогательном типе для проверки равенства были реализованы обе версии интерфейса IEqualityComparer. Существует абстракт-
ный класс System.Collections.Generic.EqualityComparer<T>, реализующий интерфейсы IEqualityComparer<T> и IEqualityComparer и содержащий виртуаль-
ные методы Equals() и GetHashCode(). Можно наследовать от этого класса и заместить его виртуальные методы.
public class Customer
{
public string FirstName { get; set; } public string LastName { get; set; }
}
public class LastFirstComparer : EqualityComparer<Customer>
{
public override bool Equals(Customer x, Customer y)
{
return x.LastName == y.LastName && x.FirstName == y.FirstName;
}
public override int GetHashCode(Customer obj)
{
return (obj.LastName + ";" + obj.FirstName).GetHashCode();
}
}
Статическое свойство EqualityComparer<T>.Default возвращает экземпляр EqualityComparer<T> для типа T. Этот экземпляр использует метод Equals(T)
18
либо метод Equals(object) в зависимости от того, реализует ли T интерфейс
IEquatable<T>.
6. Сравнение для выяснения порядка
Стандартным способом сравнения для выяснения порядка является реали-
зация типом интерфейсов IComparable и IComparable<T>:
public interface IComparable
{
int CompareTo(object other);
}
public interface IComparable<in T>
{
int CompareTo(T other);
}
Оба интерфейса предоставляют одинаковый функционал. Универсальный интерфейс IComparable<T> избавляет от необходимости упаковки при работе с типами значений. Метод x.CompareTo(y) должен возвращать любое положительное число, если x «больше» y, отрицательное число, если x «меньше» y, и ноль, если x и y равны.
Базовые типы реализуют обе версии интерфейса IComparable. В типе string метод CompareTo() выполняет чувствительное к регистру сравнение строк с учётом региональных стандартов. В некоторых базовых типах дополнительно определён статический метод сравнения Compare(). Например, string имеет перегруженные версии Compare(), которые принимают или элемент перечисления StringComparison, или булев флаг (игнорирование регистра) и объ-
ект CultureInfo:
string s1 = "Strasse", s2 = "Straße";
// порядковое сравнение, i = -108
int i = string.Compare(s1, s2, StringComparison.Ordinal);
// j = 0, так как в немецком языке такие слова равны
int j = string.Compare(s1, s2, false, new CultureInfo("de-DE"));
Кроме реализации IComparable и IComparable<T> тип может дополнительно перегружать операции < и >. Перегрузка операций сравнения обычно выполняется, если результат операции не зависит от контекста выполнения1.
bool isAfterDoomsday = DateTime.Now > new DateTime(2012, 12, 21);
1 Тип string не перегружает операции сравнения, так как результат может измениться в зависимости от текущих региональных стандартов.
19
Как и в случае проверки на равенство, сравнение для выяснения порядка можно выполнить при помощи подключаемых интерфейсов. Для порядкового сравнения предназначены интерфейсы IComparer<T> и IComparer (пространства
имён System.Collections.Generic и System.Collections).
public interface IComparer
{
int Compare(object x, object y);
}
public interface IComparer<in T>
{
int Compare(T x, T y);
}
Существует абстрактный класс System.Collections.Generic.Comparer<T>,
облегчающий реализацию интерфейсов IComparer<T> и IComparer:
public class Wish
{
public string Name { get; set; } public int Priority { get; set; }
}
public class PriorityComparer : Comparer<Wish>
{
public override int Compare(Wish x, Wish y)
{
if (Equals(x, y))
{
return 0;
}
return x.Priority.CompareTo(y.Priority);
}
}
Статическое свойство Comparer<T>.Default возвращает экземпляр Comparer<T> для типа T. Этот экземпляр использует метод CompareTo(T) либо метод CompareTo(object) в зависимости от того, реализует ли T интерфейс
IComparable<T>.
Абстрактный класс System.StringComparer предназначен для сравнения строк с учётом языка и регистра. Этот класс реализует интерфейсы IComparer,
IEqualityComparer, IComparer<string> и IEqualityComparer<string>. Некото-
рые неабстрактные наследники StringComparer доступны через его статические свойства. Например, свойство StringComparer.CurrentCulture возвращает объект, реализующий сравнение строк с учётом текущих региональных стандартов.
20