isEqual：およびハッシュをオーバーライドするためのベストプラクティス

isEqual:Objective-Cではどのように適切にオーバーライドしますか？「キャッチ」は、2つのオブジェクトが等しい場合（isEqual:メソッドによって決定される）、それらは同じハッシュ値を持つ必要があるようです。

Cocoa Fundamentals GuideのIntrospectionセクションには、オーバーライドする方法の例があり、次のようにコピーされます。isEqual:MyWidget

- (BOOL)isEqual:(id)other {
    if (other == self)
        return YES;
    if (!other || ![other isKindOfClass:[self class]])
        return NO;
    return [self isEqualToWidget:other];
}

- (BOOL)isEqualToWidget:(MyWidget *)aWidget {
    if (self == aWidget)
        return YES;
    if (![(id)[self name] isEqual:[aWidget name]])
        return NO;
    if (![[self data] isEqualToData:[aWidget data]])
        return NO;
    return YES;
}

ポインタの等価性をチェックし、次にクラスの等価性をチェックし、最後isEqualToWidget:にnameとdataプロパティをチェックするだけを使用してオブジェクトを比較します。例に示されていないのは、オーバーライドする方法hashです。

たとえば、平等に影響を与えないプロパティが他にもあるとしましょうage。すべきではないhash方法が唯一のよう上書きすることnameやdataハッシュに影響を与えますか？もしそうなら、あなたはそれをどのように行いますか？ただのハッシュを追加するnameとdata？例えば：

- (NSUInteger)hash {
    NSUInteger hash = 0;
    hash += [[self name] hash];
    hash += [[self data] hash];
    return hash;
}

それで十分ですか？より良いテクニックはありますか？あなたがのようなプリミティブを持っている場合はどうなりますintか？それらを変換しNSNumberてハッシュを取得しますか？または構造体NSRect？

（Brain fart：もともとは「ビット単位OR」と一緒に|=。Meant add と一緒に書いたものです。）

皮切りに

 NSUInteger prime = 31;
 NSUInteger result = 1;

次に、プリミティブごとに

 result = prime * result + var

オブジェクトの場合、nilには0を使用し、それ以外の場合はハッシュコードを使用します。

 result = prime * result + [var hash];

ブール値の場合、2つの異なる値を使用します

 result = prime * result + ((var)?1231:1237);

説明と帰属

これはtcurdtの仕事ではなく、コメントはより多くの説明を求めていたので、帰属の編集は公平だと思います。

このアルゴリズムは「Effective Java」という本で普及し、現在、関連する章がオンラインでここにあります。その本はアルゴリズムを普及させ、現在では多くのJavaアプリケーション（Eclipseを含む）のデフォルトとなっています。ただし、Dan BernsteinまたはChris Torekにさまざまな原因があると考えられるさらに古い実装から派生したものです。その古いアルゴリズムは元々Usenetにあり、特定の帰属は困難です。たとえば、このApacheコードには、元のソースを参照する興味深い注釈（名前を検索）があります。

要するに、これは非常に古く、単純なハッシュアルゴリズムです。これは最もパフォーマンスが高くはなく、数学的には「良い」アルゴリズムであることが証明されていません。しかし、それは単純であり、多くの人々が長い間それを使用して良好な結果を得ているので、多くの歴史的なサポートがあります。

私はObjective-Cを自分で手に取っているだけなので、その言語について具体的に話すことはできませんが、他の言語では、2つのインスタンスが「等しい」場合、同じハッシュを返す必要があります。それらをハッシュテーブル（または任意の辞書タイプのコレクション）のキーとして使用しようとすると、ある種の問題が発生します。

一方、2つのインスタンスが等しくない場合、それらは同じハッシュを持つ場合と持たない場合があります。そうでない場合が最適です。これがハッシュテーブルのO（1）検索とO（N）検索の違いです。すべてのハッシュが衝突した場合、テーブルを検索することはリストを検索することよりも優れていることに気付くかもしれません。

ベストプラクティスの観点から、ハッシュは入力に対して値のランダムな分布を返す必要があります。これは、たとえば、doubleがあり、値の大部分が0から100の間でクラスター化する傾向がある場合、それらの値によって返されるハッシュが、可能なハッシュ値の範囲全体に均等に分散されていることを確認する必要があることを意味します。これにより、パフォーマンスが大幅に向上します。

いくつかのハッシュアルゴリズムがあり、そのうちいくつかはここにリストされています。パフォーマンスに大きな影響を与える可能性があるため、新しいハッシュアルゴリズムを作成しないようにしています。したがって、既存のハッシュメソッドを使用し、例で行うように、ある種のビットごとの組み合わせを行うことは、それを回避する良い方法です。

重要なプロパティのハッシュ値に対する単純なXORで、99％の時間で十分です。

例えば：

- (NSUInteger)hash
{
    return [self.name hash] ^ [self.data hash];
}

Mattt Thompsonがhttp://nshipster.com/equality/で見つけた解決策（この質問にも彼の投稿で言及されています！）

このスレッドは、自分isEqual:とhashメソッドを1つのキャッチで実装するために必要なすべてを提供するのに非常に役立つことがわかりました。isEqual:サンプルコードでオブジェクトインスタンス変数をテストする場合、以下を使用します。

if (![(id)[self name] isEqual:[aWidget name]])
    return NO;

ユニットテストでオブジェクトが同一であることを知ったときに、エラーなしで繰り返し失敗しました（つまり、NOが返されました）。その理由は、インスタンス変数の1つがnilだったため、上記のステートメントは次のとおりでした。NSString

if (![nil isEqual: nil])
    return NO;

以来とnilのいずれかの方法に応答します、これは完全に合法であるが、

[nil isEqual: nil]

NOであるnilを返すため、オブジェクトとテスト対象のオブジェクトの両方にnilオブジェクトがある場合、それらは等しくないと見なされます（つまり、NOを返します）。isEqual:

この簡単な修正は、ifステートメントを次のように変更することでした。

if ([self name] != [aWidget name] && ![(id)[self name] isEqual:[aWidget name]])
    return NO;

彼らは両方のであれば、この方法では、それらのアドレスが同じであれば、それは関係なく、メソッドの呼び出しをスキップしないゼロまたは同じオブジェクトへの両方のポインティングが、どちらかではない場合はnilか、彼らはその後、コンパレータが適切と呼ばれる別のオブジェクトを指します。

これにより、誰かが頭を掻く数分を節約できることを願っています。

ハッシュ関数は、別のオブジェクトのハッシュ値と衝突したり一致したりする可能性が低い半一意の値を作成する必要があります。

これが完全なハッシュ関数で、クラスのインスタンス変数に適合させることができます。64/32ビットアプリケーションとの互換性のために、intではなくNSUIntegerを使用しています。

異なるオブジェクトで結果が0になると、ハッシュが衝突するリスクがあります。ハッシュ関数に依存する一部のコレクションクラスを操作する場合、ハッシュが衝突するとプログラムが予期しない動作をする可能性があります。ハッシュ関数を使用する前に必ずテストしてください。

-(NSUInteger)hash {
    NSUInteger result = 1;
    NSUInteger prime = 31;
    NSUInteger yesPrime = 1231;
    NSUInteger noPrime = 1237;

    // Add any object that already has a hash function (NSString)
    result = prime * result + [self.myObject hash];

    // Add primitive variables (int)
    result = prime * result + self.primitiveVariable; 

    // Boolean values (BOOL)
    result = prime * result + (self.isSelected?yesPrime:noPrime);

    return result;
}

簡単だが非効率的な方法は-hash、すべてのインスタンスに対して同じ値を返すことです。それ以外の場合は、はい、同等性に影響するオブジェクトのみに基づいてハッシュを実装する必要があります。で緩やかな比較を使用する場合、これはトリッキーです-isEqual:（たとえば、大文字と小文字を区別しない文字列比較）。intの場合、NSNumbersと比較しない限り、通常はint自体を使用できます。

| =は使用しないでください。飽和します。代わりに^ =を使用してください。

ランダムな楽しい事実：[[NSNumber numberWithInt:0] isEqual:[NSNumber numberWithBool:NO]]、しかし[[NSNumber numberWithInt:0] hash] != [[NSNumber numberWithBool:NO] hash]。（rdar：// 4538282、2006年5月5日からオープン）

isEqualtrue の場合に等しいハッシュのみを提供する必要があることに注意してください。場合はisEqualfalseで、ハッシュは、おそらくそれはですが、不平等である必要はありません。したがって：

ハッシュは単純にしてください。最も特徴的なメンバー（またはいくつかのメンバー）変数を選択します。

たとえば、CLPlacemarkの場合、名前だけで十分です。はい、まったく同じ名前の2つまたは3つの異なるCLPlacemarkがありますが、それらはまれです。そのハッシュを使用します。

@interface CLPlacemark (equal)
- (BOOL)isEqual:(CLPlacemark*)other;
@end

@implementation CLPlacemark (equal)

...

-(NSUInteger) hash
{
    return self.name.hash;
}


@end

市や国などを指定する必要はありません。名前で十分です。おそらく名前とCLLocation。

ハッシュは均等に分散する必要があります。したがって、キャレット^（xor記号）を使用して複数のメンバー変数を組み合わせることができます

だからそれはのようなものです

hash = self.member1.hash ^ self.member2.hash ^ self.member3.hash

これにより、ハッシュが均等に分散されます。

Hash must be O(1), and not O(n)

では、配列で何をすべきか？

繰り返しますが、簡単です。配列のすべてのメンバーをハッシュする必要はありません。最初の要素、最後の要素、カウント、おそらくいくつかの中間要素をハッシュするのに十分であり、それだけです。

ちょっと待ってください。これを行うにははるかに簡単な方法ですが、最初にオーバーライド- (NSString )descriptionして、オブジェクトの状態の文字列表現を提供することです（オブジェクトの状態全体をこの文字列で表す必要があります）。

次に、次の実装を提供しますhash：

- (NSUInteger)hash {
    return [[self description] hash];
}

これは、「2つの文字列オブジェクトが等しい場合（isEqualToString：メソッドで決定）、それらは同じハッシュ値でなければならない」という原則に基づいています。

ソース：NSStringクラスリファレンス

等号とハッシュのコントラクトは、Javaの世界では十分に指定され、徹底的に調査されていますが（@mipardiの回答を参照）、Objective-Cにも同じ考慮事項が当てはまるはずです。

EclipseはこれらのメソッドをJavaで生成するという信頼できる仕事をしているので、Objective-Cに手作業で移植したEclipseの例を次に示します。

- (BOOL)isEqual:(id)object {
    if (self == object)
        return true;
    if ([self class] != [object class])
        return false;
    MyWidget *other = (MyWidget *)object;
    if (_name == nil) {
        if (other->_name != nil)
            return false;
    }
    else if (![_name isEqual:other->_name])
        return false;
    if (_data == nil) {
        if (other->_data != nil)
            return false;
    }
    else if (![_data isEqual:other->_data])
        return false;
    return true;
}

- (NSUInteger)hash {
    const NSUInteger prime = 31;
    NSUInteger result = 1;
    result = prime * result + [_name hash];
    result = prime * result + [_data hash];
    return result;
}

そしてYourWidget、プロパティを追加するサブクラスの場合serialNo：

- (BOOL)isEqual:(id)object {
    if (self == object)
        return true;
    if (![super isEqual:object])
        return false;
    if ([self class] != [object class])
        return false;
    YourWidget *other = (YourWidget *)object;
    if (_serialNo == nil) {
        if (other->_serialNo != nil)
            return false;
    }
    else if (![_serialNo isEqual:other->_serialNo])
        return false;
    return true;
}

- (NSUInteger)hash {
    const NSUInteger prime = 31;
    NSUInteger result = [super hash];
    result = prime * result + [_serialNo hash];
    return result;
}

この実装により、isEqual:Apple のサンプルにあるサブクラス化の落とし穴がいくつか回避されます。

• Appleのクラステストother isKindOfClass:[self class]は、の2つの異なるサブクラスに対して非対称ですMyWidget。等式は対称である必要があります：b = aの場合のみ、a = bです。これは、テストをother isKindOfClass:[MyWidget class]に変更することで簡単に修正でき、すべてのMyWidgetサブクラスは相互に比較できます。
• isKindOfClass:サブクラステストを使用すると、サブクラスisEqual:が洗練された等価テストで上書きされるのを防ぐことができます。これは、等式が推移的である必要があるためです。a= bおよびa = cの場合、b = cです。場合MyWidgetインスタンスが2つのに等しい比較YourWidget例では、それらのYourWidgetインスタンスがあっても、その場合、互いに等しい必要がありますserialNo異なります。

2番目の問題は、オブジェクトがまったく同じクラスに属している場合にオブジェクトが等しいと見なすことで修正できるため、[self class] != [object class]ここでテストします。一般的なアプリケーションクラスの場合、これが最善のアプローチのようです。

ただし、isKindOfClass:テストが望ましい場合もあります。これは、アプリケーションクラスよりもフレームワーククラスの方が一般的です。たとえば、/の区別に関係なく、またクラスクラスター内のどのプライベートクラスが関係しているかに関係なく、any NSStringはNSString同じ基本文字シーケンスを持つ他のものと同等に比較する必要があります。NSStringNSMutableStringNSString

そのような場合、isEqual:は明確に定義され、十分に文書化された動作をする必要があり、サブクラスがこれをオーバーライドできないことを明確にする必要があります。Javaでは、「オーバーライドなし」の制限は、equalsメソッドとhashcodeメソッドにとしてフラグを立てることによって適用できますfinalが、Objective-Cには同等のものはありません。

これはあなたの質問に直接答えることはありません（まったく）が、私は以前にMurmurHashを使用してハッシュを生成しました：murmurhash

理由を説明する必要があると思います：murmurhashは非常に高速です...

このページは、equals-およびhash-typeオーバーライドメソッドのガイドとして役立つことがわかりました。ハッシュコードを計算するためのまともなアルゴリズムが含まれています。このページはJavaを対象としていますが、Objective-C / Cocoaに簡単に適合させることができます。

私もObjective Cの初心者だけど、私はObjective Cの中のアイデンティティ対平等に関する優れた記事見つけ、ここを。私が読んだところ、デフォルトのハッシュ関数（一意のIDを提供する必要があります）を保持し、isEqualメソッドを実装してデータ値を比較できるようになっているようです。

クインはつぶやきハッシュへの参照がここでは役に立たないのは間違いです。クインは、ハッシュの背後にある理論を理解したいのは正しいです。つぶやきは、その理論の多くを実装に蒸留します。この特定のアプリケーションにその実装を適用する方法を理解することは、探索する価値があります。

ここで重要なポイントのいくつか：

tcurdtの関数例は、'31 'が素数であるため、適切な乗数であることを示唆しています。プライムであることは必要かつ十分な条件であることを示す必要があります。実際、31 == -1％32であるため、31（および7）はおそらく特に優れた素数ではありません。約半分のビットが設定され、半分のビットがクリアされている奇数乗数がより優れている可能性があります。（つぶやきハッシュ乗算定数にはその性質があります。）

このタイプのハッシュ関数は、乗算した後、シフトとxorを使用して結果値を調整した場合、より強力になる可能性があります。乗算は、レジスタの上限で多くのビット相互作用の結果を生成し、レジスタの下端で相互作用の結果を低くする傾向があります。シフトとxorは、レジスタの下端での相互作用を増やします。

約半分のビットがゼロであり、約半分のビットが1である値に初期結果を設定することも役立つ傾向があります。

要素が結合される順序に注意することは有用かもしれません。おそらく最初に、値が強く分散されていないブール値やその他の要素を処理する必要があります。

計算の最後に、ビットスクランブルステージをいくつか追加すると便利な場合があります。

このアプリケーションで雑音雑音が実際に高速であるかどうかは、未解決の問題です。つぶやきハッシュは、各入力ワードのビットを事前混合します。複数の入力ワードを並行して処理できるため、複数の問題をパイプライン化したCPUを使用できます。

プロパティ名を取得するための@tcurdtの回答と@ oscar-gomezの回答を組み合わせると、isEqualとハッシュの両方の簡単なドロップインソリューションを作成できます。

NSArray *PropertyNamesFromObject(id object)
{
    unsigned int propertyCount = 0;
    objc_property_t * properties = class_copyPropertyList([object class], &propertyCount);
    NSMutableArray *propertyNames = [NSMutableArray arrayWithCapacity:propertyCount];

    for (unsigned int i = 0; i < propertyCount; ++i) {
        objc_property_t property = properties[i];
        const char * name = property_getName(property);
        NSString *propertyName = [NSString stringWithUTF8String:name];
        [propertyNames addObject:propertyName];
    }
    free(properties);
    return propertyNames;
}

BOOL IsEqualObjects(id object1, id object2)
{
    if (object1 == object2)
        return YES;
    if (!object1 || ![object2 isKindOfClass:[object1 class]])
        return NO;

    NSArray *propertyNames = PropertyNamesFromObject(object1);
    for (NSString *propertyName in propertyNames) {
        if (([object1 valueForKey:propertyName] != [object2 valueForKey:propertyName])
            && (![[object1 valueForKey:propertyName] isEqual:[object2 valueForKey:propertyName]])) return NO;
    }

    return YES;
}

NSUInteger MagicHash(id object)
{
    NSUInteger prime = 31;
    NSUInteger result = 1;

    NSArray *propertyNames = PropertyNamesFromObject(object);

    for (NSString *propertyName in propertyNames) {
        id value = [object valueForKey:propertyName];
        result = prime * result + [value hash];
    }

    return result;
}

さて、あなたのカスタムクラスに簡単に実装することができますisEqual:とhash：

- (NSUInteger)hash
{
    return MagicHash(self);
}

- (BOOL)isEqual:(id)other
{
    return IsEqualObjects(self, other);
}

作成後に変更できるオブジェクトを作成している場合、オブジェクトがコレクションに挿入されてもハッシュ値は変更されないことに注意してください。実際には、これは、最初のオブジェクト作成の時点からハッシュ値を修正する必要があることを意味します。詳細については、NSObjectプロトコルの-hashメソッドに関するAppleのドキュメントを参照してください。

コレクション内のオブジェクトの位置を決定するためにハッシュ値を使用するコレクションに変更可能なオブジェクトが追加された場合、オブジェクトがコレクション内にある間、オブジェクトのハッシュメソッドによって返される値は変更できません。したがって、ハッシュメソッドがオブジェクトの内部状態情報に依存していないか、オブジェクトがコレクション内にあるときにオブジェクトの内部状態情報が変更されないようにする必要があります。したがって、たとえば、可変ディクショナリはハッシュテーブルに入れることができますが、そこにある間は変更しないでください。（特定のオブジェクトがコレクション内にあるかどうかを知るのは難しい場合があることに注意してください。）

潜在的にハッシュルックアップの効率が大幅に低下する可能性があるので、これは私にとって完全な改造のように聞こえますが、注意を怠って、ドキュメントの説明に従っている方がよいと思います。

ここで完全なボフィンを鳴らす危険がある場合は申し訳ありませんが... ...「ベストプラクティス」に従うために誰も言及しなくても、ターゲットオブジェクトが所有するすべてのデータを考慮に入れないequalsメソッドを絶対に指定しないでください。データは、オブジェクトのアソシエートではなく、オブジェクトに集約されます。比較で「年齢」を考慮に入れたくない場合は、コンパレーターを作成し、isEqual：の代わりにそれを使用して比較を実行する必要があります。

等値比較を任意に実行するisEqual：メソッドを定義すると、等値解釈の「ひねり」を忘れると、このメソッドが別の開発者または自分自身によって誤用されるリスクが生じます。

エルゴ、これはハッシュに関する素晴らしいQ＆Aですが、通常はハッシュ方法を再定義する必要はありません。代わりにアドホックコンパレータを定義する必要があります。