Как C # выяснить хеш-код для объекта?

Question

Этот вопрос возникает из обсуждения кортежей .

Я начал думать о хэш-коде, который должен иметь кортеж. Что если мы примем класс KeyValuePair в качестве кортежа? Он не переопределяет метод GetHashCode (), поэтому, вероятно, он не будет знать о хэш-кодах своих «потомков» ... Итак, во время выполнения будет вызываться Object.GetHashCode (), который не знает о структура реального объекта.

Тогда мы можем сделать два экземпляра некоторого ссылочного типа, которые на самом деле равны, из-за перегруженных GetHashCode () и Equals (). И используйте их как «детей» в кортежах, чтобы «обмануть» словарь.

Но это не работает! Во время выполнения каким-то образом выясняется структура нашего кортежа и вызывается перегруженный GetHashCode нашего класса!

Как это работает? Каков анализ, сделанный Object.GetHashCode ()?

Может ли это повлиять на производительность в каком-то плохом сценарии, когда мы используем сложные ключи? (возможно, сценарий невозможен ... но все же)

Рассмотрим этот код в качестве примера:

namespace csharp_tricks
{
    class Program
    {
        class MyClass
        {
            int keyValue;
            int someInfo;

            public MyClass(int key, int info)
            {
                keyValue = key;
                someInfo = info;
            }

            public override bool Equals(object obj)
            {
                MyClass other = obj as MyClass;
                if (other == null) return false;

                return keyValue.Equals(other.keyValue);
            }

            public override int GetHashCode()
            {
                return keyValue.GetHashCode();
            }
        }

        static void Main(string[] args)
        {
            Dictionary<object, object> dict = new Dictionary<object, object>();

            dict.Add(new KeyValuePair<MyClass,object>(new MyClass(1, 1), 1), 1);

            //here we get the exception -- an item with the same key was already added
            //but how did it figure out the hash code?
            dict.Add(new KeyValuePair<MyClass,object>(new MyClass(1, 2), 1), 1); 

            return;
        }
    }
}

Обновление Мне кажется, я нашел объяснение этому, как указано ниже в моем ответе. Основные результаты этого:

• Будьте осторожны с вашими ключами и их хэш-кодами: -)
• Для сложных словарных ключей вы должны корректно переопределить Equals () и GetHashCode ().

Answer 1

Не переопределяйте GetHashcode () и Equals () в изменяемых классах, переопределяйте его только в неизменяемых классах или структурах, иначе, если вы измените объект, используемый в качестве ключа, хеш-таблица больше не будет работать должным образом (вы не будете быть в состоянии получить значение, связанное с ключом после изменения ключевого объекта)

Также хеш-таблицы не используют хеш-коды для идентификации объектов, они сами используют ключевые объекты в качестве идентификаторов, не обязательно, чтобы все ключи, которые используются для добавления записей в хеш-таблицу, возвращали разные хеш-коды, но рекомендуется, чтобы они делали иначе производительность сильно страдает.

Answer 2

Вот правильные реализации Hash и равенства для кортежа Quad (содержит 4 компонента кортежа внутри). Этот код обеспечивает правильное использование этого конкретного кортежа в HashSets и словарях.

Подробнее по теме (включая исходный код) здесь .

Примечание использование ключевого слова unchecked (во избежание переполнения) и создание исключения NullReferenceException, если obj равно null (как требуется базовым методом)

public override bool Equals(object obj)
{
    if (ReferenceEquals(null, obj))
        throw new NullReferenceException("obj is null");
    if (ReferenceEquals(this, obj)) return true;
    if (obj.GetType() != typeof (Quad<T1, T2, T3, T4>)) return false;
    return Equals((Quad<T1, T2, T3, T4>) obj);
}

public bool Equals(Quad<T1, T2, T3, T4> obj)
{
    if (ReferenceEquals(null, obj)) return false;
    if (ReferenceEquals(this, obj)) return true;
    return Equals(obj.Item1, Item1)
        && Equals(obj.Item2, Item2)
            && Equals(obj.Item3, Item3)
                && Equals(obj.Item4, Item4);
}

public override int GetHashCode()
{
    unchecked
    {
        int result = Item1.GetHashCode();
        result = (result*397) ^ Item2.GetHashCode();
        result = (result*397) ^ Item3.GetHashCode();
        result = (result*397) ^ Item4.GetHashCode();
        return result;
    }
}
public static bool operator ==(Quad<T1, T2, T3, T4> left, Quad<T1, T2, T3, T4> right)
{
    return Equals(left, right);
}


public static bool operator !=(Quad<T1, T2, T3, T4> left, Quad<T1, T2, T3, T4> right)
{
    return !Equals(left, right);
}

Answer 3

Посмотрите эту запись Брэда Абрамса, а также комментарий Брайана Грюнкемейера для получения дополнительной информации о том, как работает object.GetHashCode. Кроме того, взгляните на первый комментарий в блоге Аянде post . Я не знаю, соответствуют ли текущие версии Framework этим правилам или они действительно изменили его, как подразумевал Брэд.

Answer 4

Кажется, теперь у меня есть подсказка.

Я думал, что KeyValuePair является ссылочным типом, но это не так, это структура. И поэтому он использует метод ValueType.GetHashCode (). В MSDN указано: «Одно или несколько полей производного типа используются для вычисления возвращаемого значения».

Если вы возьмете реальный тип ссылки в качестве «провайдера кортежей», вы обманете словарь (или себя ...).

using System.Collections.Generic;

namespace csharp_tricks
{
    class Program
    {
        class MyClass
        {
            int keyValue;
            int someInfo;

            public MyClass(int key, int info)
            {
                keyValue = key;
                someInfo = info;
            }

            public override bool Equals(object obj)
            {
                MyClass other = obj as MyClass;
                if (other == null) return false;

                return keyValue.Equals(other.keyValue);
            }

            public override int GetHashCode()
            {
                return keyValue.GetHashCode();
            }
        }

        class Pair<T, R>
        {
            public T First { get; set; }
            public R Second { get; set; }
        }

        static void Main(string[] args)
        {
            var dict = new Dictionary<Pair<int, MyClass>, object>();

            dict.Add(new Pair<int, MyClass>() { First = 1, Second = new MyClass(1, 2) }, 1);

            //this is a pair of the same values as previous! but... no exception this time...
            dict.Add(new Pair<int, MyClass>() { First = 1, Second = new MyClass(1, 3) }, 1);

            return;
        }
    }
}

Answer 5

так что, вероятно, он не будет знать о хэш-кодах своих "детей".

Ваш пример, кажется, доказывает обратное :-) Хеш-код для ключа MyClass и значение 1 одинаковы для обоих KeyValuePair. Реализация KeyValuePair должна использовать свои Key и Value для своего собственного хеш-кода

Двигаясь вверх, классу словаря нужны уникальные ключи. Он использует хеш-код, предоставленный каждым ключом, чтобы понять вещи. Помните, что среда выполнения не вызывает Object.GetHashCode(), но она вызывает реализацию GetHashCode (), предоставленную экземпляром, который вы ей предоставили.

Рассмотрим более сложный случай:

public class HappyClass
{

    enum TheUnit
    {
        Points,
        Picas,
        Inches
    }

    class MyDistanceClass
    {
        int distance;
        TheUnit units;

        public MyDistanceClass(int theDistance, TheUnit unit)
        {
            distance = theDistance;

            units = unit;
        }
        public static int ConvertDistance(int oldDistance, TheUnit oldUnit, TheUnit newUnit)
        {
            // insert real unit conversion code here :-)
            return oldDistance * 100;
        }

        /// <summary>
        /// Figure out if we are equal distance, converting into the same units of measurement if we have to
        /// </summary>
        /// <param name="obj">the other guy</param>
        /// <returns>true if we are the same distance</returns>
        public override bool Equals(object obj)
        {
            MyDistanceClass other = obj as MyDistanceClass;
            if (other == null) return false;

            if (other.units != this.units)
            {
                int newDistance = MyDistanceClass.ConvertDistance(other.distance, other.units, this.units);
                return distance.Equals(newDistance);
            }
            else
            {
                return distance.Equals(other.distance);
            }


        }

        public override int GetHashCode()
        {
            // even if the distance is equal in spite of the different units, the objects are not
            return distance.GetHashCode() * units.GetHashCode();
        }
    }
    static void Main(string[] args)
    {

        // these are the same distance... 72 points = 1 inch
        MyDistanceClass distPoint = new MyDistanceClass(72, TheUnit.Points);
        MyDistanceClass distInch = new MyDistanceClass(1, TheUnit.Inch);

        Debug.Assert(distPoint.Equals(distInch), "these should be true!");
        Debug.Assert(distPoint.GetHashCode() != distInch.GetHashCode(), "But yet they are fundimentally different values");

        Dictionary<object, object> dict = new Dictionary<object, object>();

        dict.Add(new KeyValuePair<MyDistanceClass, object>(distPoint, 1), 1);

        //this should not barf
        dict.Add(new KeyValuePair<MyDistanceClass, object>(distInch, 1), 1);

        return;
    }

}

В основном ... в моем примере вы хотели бы, чтобы два объекта с одинаковым расстоянием возвращали "true" для Equals, но при этом возвращали разные хэш-коды.

Answer 6

У меня больше нет ссылки на книгу, и мне нужно будет найти ее только для подтверждения, но я думал, что базовый хэш по умолчанию просто хеширует всех членов вашего объекта. Он получил к ним доступ из-за того, как работал CLR, поэтому вы не могли написать что-то еще, как они.

Это полностью из памяти того, что я кратко прочитал, поэтому примите это как хотите.

Редактировать: Книга была Внутри C # из MS Press. Тот, с лезвием пилы на обложке. Автор потратил много времени на объяснение того, как все было реализовано в CLR, как язык перешел на MSIL и т. Д. ЭСТ. Если вы можете найти книгу, это не плохое чтение.

Редактировать: Сформировать ссылку, если она выглядит как

Object.GetHashCode () использует внутреннее поле в классе System.Object для генерации хеш-значения. каждый Созданному объекту присваивается уникальный ключ объекта, сохраняемый как целое число, когда он создано. Эти ключи начинаются с 1 и увеличиваются каждый раз, когда новый объект создается любой тип.

Хмм, наверное, мне нужно написать несколько моих собственных хеш-кодов, если я собираюсь использовать объекты в качестве хеш-ключей.