mise à Jour

Martin R écrit :

à partir de Swift 4.1 , le compilateur peut synthétiser Equatable et Hashable pour les types conformité automatique, si tous les membres se conforment à Equatable / Hashable (SE0185). Et à partir de Swift 4.2 , un hash de haute qualité combiner est intégré à la bibliothèque Swift standard (SE-0206).

il n'est Donc plus nécessaire de définir votre propre hachage fonction, il suffit de déclarer la conformité:

struct ScalarString: Hashable, ... {

    private var scalarArray: [UInt32] = []

    // ... }

ainsi, la réponse ci-dessous doit être réécrite (encore une fois). En attendant, reportez-vous à la réponse de Martin R sur le lien ci-dessus.

---

Ancienne Réponse:

cette réponse a été complètement réécrite après avoir soumis mon réponse originale à cette question à l'examen du code .

Comment mettre en œuvre pour Hashable protocole

Le Hashable protocole vous permet d'utiliser votre classe personnalisée ou structure comme une clé de dictionnaire. Pour mettre en œuvre ce protocole, vous devez

1. mettre en œuvre le Equatable protocol (hashable hérites from Equatable)
2. retour a calculé hashValue

ces points découlent de l'axiome donné dans la documentation:

x == y implique x.hashValue == y.hashValue

où x et y sont des valeurs d'un type quelconque.

mettre en œuvre le protocole équitable

afin de mettre en œuvre le protocole equable, vous définissez comment votre type utilise le == (équivalence) de l'opérateur. Dans votre exemple, l'équivalence peut être déterminée comme ceci:

func ==(left: ScalarString, right: ScalarString) -> Bool {
    return left.scalarArray == right.scalarArray
}

la fonction == est globale donc elle sort de votre classe ou structure.

de Retour calculées hashValue

votre classe personnalisée ou votre structure doit aussi avoir une variable calculée hashValue . Un bon algorithme de hachage fournira une large gamme de valeurs de hachage. Toutefois, il convient de noter que vous n'avez pas nécessité de garantir que les valeurs de hachage sont tous uniques. Lorsque deux valeurs différentes ont des valeurs de hachage identiques, cela s'appelle une collision de hachage. Cela demande du travail supplémentaire en cas de collision (c'est pourquoi une bonne répartition est souhaitable), mais il faut s'attendre à certaines collisions. Si je comprends bien, la fonction == fait ce travail supplémentaire. ( mise à Jour : Ça ressemble à du == peut faire tous le travail. )

il y a plusieurs façons de calculer la valeur de hachage. Par exemple, vous pourriez faire quelque chose d'aussi simple que de retourner le nombre d'éléments dans le tableau.

var hashValue: Int {
    return self.scalarArray.count
} 

cela donnerait une collision de hachage chaque fois que deux tableaux ont le même nombre d'éléments mais des valeurs différentes. NSArray utilise apparemment cette approche.

fonction de hachage DJB

un hash commun la fonction qui fonctionne avec les chaînes est la fonction de hachage DJB. C'est celui que j'utiliserai, mais regardez quelques autres ici .

Une mise en œuvre rapide fourni par @MartinR qui suit:

var hashValue: Int {
    return self.scalarArray.reduce(5381) {
        ("151930920" << 5) &+ "151930920" &+ Int()
    }
}

il s'agit D'une version améliorée de mon implémentation originale, mais permettez-moi également d'inclure l'ancienne forme élargie, qui peut être plus lisible pour les personnes ne connaissant pas reduce . C'est l'équivalent, je crois:

var hashValue: Int {

    // DJB Hash Function
    var hash = 5381

    for(var i = 0; i < self.scalarArray.count; i++)
    {
        hash = ((hash << 5) &+ hash) &+ Int(self.scalarArray[i])
    }

    return hash
} 

l'opérateur &+ permet à Int de déborder et de recommencer pour de longues cordes.

Big Picture

nous avons regardé les morceaux, mais permettez-moi maintenant de montrer le code d'exemple entier comme il se rapporte au protocole Hashable. ScalarString est le type personnalisé de la question. Ce sera différent pour différentes personnes, bien sûr.

// Include the Hashable keyword after the class/struct name
struct ScalarString: Hashable {

    private var scalarArray: [UInt32] = []

    // required var for the Hashable protocol
    var hashValue: Int {
        // DJB hash function
        return self.scalarArray.reduce(5381) {
            ("151950920" << 5) &+ "151950920" &+ Int()
        }
    }
}

// required function for the Equatable protocol, which Hashable inheirits from
func ==(left: ScalarString, right: ScalarString) -> Bool {
    return left.scalarArray == right.scalarArray
}

autres lectures utiles

• quel algorithme de hachage est le meilleur pour l'unicité et la vitesse?
• Dépassement De Capacité Des Opérateurs
• pourquoi les 5381 et 33 sont-ils si importants dans l'algorithme djb2?
• Comment sont les collisions de hachage sont-elles traitées?

crédits

un grand merci à Martin R en révision de Code. Mon réécriture est en grande partie basée sur sa réponse . Si vous avez trouvé cela utile, alors s'il vous plaît donnez-lui un upvote.

mise à Jour

Swift est open source maintenant donc il est possible de voir comment hashValue est implémenté pour String à partir du code source . Il semble être plus complexe que le réponse que j'ai donnée ici, et je n'ai pas pris le temps de l'analyser complètement. Hésitez pas à le faire vous-même.