QHash Class

Documentation des fonctions membres

[noexcept] QHash::QHash()

Construit un hachage vide.

Voir aussi clear().

QHash::QHash(std::initializer_list<std::pair<Key, T>> list)

Construit un hachage avec une copie de chacun des éléments de la liste d'initialisation list.

template <typename InputIterator> QHash::QHash(InputIterator begin, InputIterator end)

Construit un hachage avec une copie de chacun des éléments de l'intervalle de l'itérateur [begin, end). Soit les éléments itérés par l'intervalle doivent être des objets avec des membres de données first et second (comme std::pair), convertibles en Key et T respectivement ; soit les itérateurs doivent avoir des fonctions membres key() et value(), renvoyant une clé convertible en Key et une valeur convertible en T respectivement.

[noexcept] QHash::QHash(const QHash<Key, T> &other)

Construit une copie de other.

Cette opération s'effectue en temps constant, car le QHash est implicitement partagé. Cela rend le retour d'un QHash à partir d'une fonction très rapide. Si une instance partagée est modifiée, elle sera copiée (copy-on-write), ce qui prend un temps linéaire.

Voir également operator=().

[noexcept] QHash::QHash(QHash<Key, T> &&other)

Move-construit une instance de QHash, en la faisant pointer sur le même objet que celui vers lequel other pointait.

QHash::~QHash()

Détruit le hachage. Les références aux valeurs du hachage et tous les itérateurs de ce hachage deviennent invalides.

Renvoie un objet de plage qui permet d'itérer sur ce hachage sous forme de paires clé/valeur. Par exemple, cet objet plage peut être utilisé dans une boucle for basée sur la plage, en combinaison avec une déclaration de liaison structurée :

QHash<QString, int> hash;
hash.insert("January", 1);
hash.insert("February", 2);
// ...
hash.insert("December", 12);

for (auto [key, value] : hash.asKeyValueRange()) {
    cout << qPrintable(key) << ": " << value << endl;
    --value; // convert to JS month indexing
}

Notez que la clé et la valeur obtenues de cette manière sont des références à celles du hachage. Plus précisément, la modification de la valeur modifiera le hachage lui-même.

Ces fonctions ont été introduites dans Qt 6.4.

Voir aussi QKeyValueIterator.

QHash<Key, T>::iterator QHash::begin()

Renvoie un itérateur de style STL pointant sur le premier élément du hachage.

Voir aussi constBegin() et end().

[noexcept] QHash<Key, T>::const_iterator QHash::begin() const

[noexcept] qsizetype QHash::capacity() const

Renvoie le nombre de godets dans la table de hachage interne de QHash.

Le seul but de cette fonction est de fournir un moyen d'affiner l'utilisation de la mémoire de QHash. En général, vous n'aurez que rarement besoin d'appeler cette fonction. Si vous souhaitez connaître le nombre d'éléments contenus dans la table de hachage, appelez size().

Voir aussi reserve() et squeeze().

[noexcept] QHash<Key, T>::const_iterator QHash::cbegin() const

Renvoie un itérateur constant de style STL pointant sur le premier élément du hachage.

Voir aussi begin() et cend().

[noexcept] QHash<Key, T>::const_iterator QHash::cend() const

Renvoie un itérateur constant de style STL pointant vers l'élément imaginaire situé après le dernier élément du hachage.

Voir aussi cbegin() et end().

[noexcept(...)] void QHash::clear()

Supprime tous les éléments du hachage et libère toute la mémoire utilisée par celui-ci.

Voir également remove().

[noexcept] QHash<Key, T>::const_iterator QHash::constBegin() const

Renvoie un itérateur constant de style STL pointant sur le premier élément du hachage.

Voir aussi begin() et constEnd().

[noexcept] QHash<Key, T>::const_iterator QHash::constEnd() const

Renvoie un itérateur constant de style STL pointant vers l'élément imaginaire situé après le dernier élément du hachage.

Voir aussi constBegin() et end().

[noexcept] QHash<Key, T>::const_iterator QHash::constFind(const Key &key) const

Renvoie un itérateur pointant vers l'élément contenant le key dans le hachage.

Si le hachage ne contient pas d'élément avec key, la fonction renvoie constEnd().

Voir aussi find().

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::constKeyValueBegin() const

Renvoie un itérateur constant de style STL pointant sur la première entrée du hachage.

Voir aussi keyValueBegin().

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::constKeyValueEnd() const

Renvoie un itérateur constant de style STL pointant vers l'entrée imaginaire située après la dernière entrée du hachage.

Voir aussi constKeyValueBegin().

[noexcept] bool QHash::contains(const Key &key) const

Renvoie true si le hachage contient un élément avec key; sinon, renvoie false.

Voir aussi count().

[noexcept] qsizetype QHash::count(const Key &key) const

Renvoie le nombre d'éléments associés à key.

Voir aussi contains().

[noexcept] qsizetype QHash::count() const

Identique à size().

Insère un nouvel élément dans le conteneur. Ce nouvel élément est construit sur place en utilisant args comme arguments pour sa construction.

Retourne un itérateur pointant vers le nouvel élément.

[noexcept] bool QHash::empty() const

Cette fonction est fournie pour des raisons de compatibilité avec la STL. Elle est équivalente à isEmpty(), renvoyant vrai si le hachage est vide ; sinon, elle renvoie false.

[noexcept] QHash<Key, T>::iterator QHash::end()

Renvoie un itérateur de style STL pointant vers l'élément imaginaire situé après le dernier élément du hachage.

Voir aussi begin() et constEnd().

[noexcept] QHash<Key, T>::const_iterator QHash::end() const

QHash<Key, T>::iterator QHash::erase(QHash<Key, T>::const_iterator pos)

Supprime du hachage la paire (clé, valeur) associée à l'itérateur pos et renvoie un itérateur vers l'élément suivant du hachage.

Cette fonction n'oblige jamais QHash à réorganiser sa structure de données interne. Cela signifie qu'elle peut être appelée en toute sécurité pendant l'itération et qu'elle n'affectera pas l'ordre des éléments dans le hachage. Par exemple, cette fonction peut être appelée en toute sécurité pendant l'exécution d'une requête :

QHash<QObject *, int> objectHash;
//...
QHash<QObject *, int>::iterator i = objectHash.find(obj);
while (i != objectHash.end() && i.key() == obj) {
    if (i.value() == 0) {
        i = objectHash.erase(i);
    } else {
        ++i;
    }
}

Voir aussi remove(), take(), et find().

QHash<Key, T>::iterator QHash::find(const Key &key)

Renvoie un itérateur pointant vers l'élément contenant le key dans le hachage.

Si le hachage ne contient aucun élément avec key, la fonction renvoie end().

Si le hachage contient plusieurs éléments avec key, cette fonction renvoie un itérateur qui pointe sur la valeur la plus récemment insérée. Les autres valeurs sont accessibles en incrémentant l'itérateur. Par exemple, voici un code qui permet d'itérer sur tous les éléments ayant la même clé :

QHash<QString, int> hash;
//...
QHash<QString, int>::const_iterator i = hash.find("HDR");
while (i != hash.end() && i.key() == "HDR") {
    cout << i.value() << endl;
    ++i;
}

Voir aussi value() et values().

[noexcept] QHash<Key, T>::const_iterator QHash::find(const Key &key) const

void QHash::insert(const QHash<Key, T> &other)

Insère tous les éléments du hachage other dans ce hachage.

Si une clé est commune aux deux hachages, sa valeur sera remplacée par la valeur stockée dans other.

QHash<Key, T>::iterator QHash::insert(const Key &key, const T &value)

Insère un nouvel élément avec l'adresse key et la valeur value.

S'il existe déjà un élément avec la valeur key, la valeur de cet élément est remplacée par value.

Retourne un itérateur pointant vers l'élément nouveau/mise à jour.

Ces fonctions ont été introduites dans Qt 6.11.

Tente d'insérer un élément avec les valeurs key et value. Si un élément avec key existe déjà, sa valeur est remplacée par value.

Retourne une instance de TryEmplaceResult, une structure qui contient un iterator pour l'élément, et un booléen, inserted, indiquant si l'élément a été nouvellement créé (true) ou s'il existait déjà (false).

Ces fonctions ont été introduites dans Qt 6.9.

Voir également insert(), tryEmplace() et tryInsert().

Tente d'insérer un élément avec les valeurs key et value. Si un élément avec key existe déjà, sa valeur est remplacée par value.

Renvoie une paire composée d'un itérateur pointant vers l'élément et d'un booléen indiquant si l'élément a été nouvellement créé (true) ou s'il existait déjà (false).

Ces fonctions sont fournies à des fins de compatibilité avec la bibliothèque standard.

Ces fonctions ont été introduites dans Qt 6.9.

Voir également insert(), tryEmplace(), tryInsert() et insertOrAssign().

Tente d'insérer un élément avec les valeurs key et value. Si un élément avec key existe déjà, sa valeur est remplacée par value.

Renvoie une paire composée d'un itérateur pointant vers l'élément et d'un booléen indiquant si l'élément a été nouvellement créé (true) ou s'il existait déjà (false).

hint est ignoré.

Ces fonctions sont fournies à des fins de compatibilité avec la bibliothèque standard.

Ces fonctions ont été introduites dans Qt 6.9.

Voir également insert(), tryEmplace() et insertOrAssign().

[noexcept] bool QHash::isEmpty() const

Renvoie true si le hachage ne contient aucun élément ; sinon, renvoie false.

Voir aussi size().

Renvoie la première clé associée à value. Si le hachage ne contient aucun élément associé à value, il renvoie defaultKey, ou une clé construite par défaut si ce paramètre n'a pas été fourni.

Cette fonction peut être lente(temps linéaire), car la structure de données interne de QHash est optimisée pour une recherche rapide par clé, et non par valeur.

[noexcept] QHash<Key, T>::key_iterator QHash::keyBegin() const

Renvoie un itérateur constant de style STL pointant sur la première clé du hachage.

Voir aussi keyEnd().

[noexcept] QHash<Key, T>::key_iterator QHash::keyEnd() const

Renvoie un itérateur constant de style STL pointant vers l'élément imaginaire situé après la dernière clé du hachage.

Voir aussi keyBegin().

QHash<Key, T>::key_value_iterator QHash::keyValueBegin()

Renvoie un itérateur de style STL pointant sur la première entrée du hachage.

Voir aussi keyValueEnd().

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::keyValueBegin() const

Renvoie un itérateur constant de style STL pointant sur la première entrée du hachage.

Voir aussi keyValueEnd().

QHash<Key, T>::key_value_iterator QHash::keyValueEnd()

Renvoie un itérateur de style STL pointant vers l'entrée imaginaire située après la dernière entrée du hachage.

Voir aussi keyValueBegin().

[noexcept] QHash<Key, T>::const_key_value_iterator QHash::keyValueEnd() const

Renvoie un itérateur constant de style STL pointant vers l'entrée imaginaire située après la dernière entrée du hachage.

Voir aussi keyValueBegin().

QList<Key> QHash::keys() const

Renvoie une liste contenant toutes les clés du hachage, dans un ordre arbitraire.

L'ordre est garanti être le même que celui utilisé par values().

Cette fonction crée une nouvelle liste en temps linéaire. L'utilisation du temps et de la mémoire que cela implique peut être évitée en itérant de keyBegin() à keyEnd().

Voir aussi values() et key().

QList<Key> QHash::keys(const T &value) const

Renvoie une liste contenant toutes les clés associées à la valeur value, dans un ordre arbitraire.

Cette fonction peut être lente(temps linéaire), car la structure de données interne de QHash est optimisée pour une recherche rapide par clé et non par valeur.

[noexcept] float QHash::load_factor() const

Renvoie le facteur de charge actuel de la table de hachage interne de QHash. C'est la même chose que capacity()/size(). L'implémentation utilisée vise à maintenir le facteur de charge entre 0,25 et 0,5. Cela permet d'éviter un trop grand nombre de collisions dans la table de hachage, ce qui dégraderait les performances.

Même avec un faible facteur de charge, l'implémentation de la table de hachage a une très faible surcharge de mémoire.

Cette méthode n'existe qu'à des fins de diagnostic et vous devriez rarement avoir besoin de l'appeler vous-même.

Voir aussi reserve() et squeeze().

bool QHash::remove(const Key &key)

Supprime l'élément qui possède la clé key du hachage. Retourne true si la clé existe dans le hash et que l'élément a été supprimé, et false sinon.

Voir aussi clear() et take().

[since 6.1] template <typename Predicate> qsizetype QHash::removeIf(Predicate pred)

Supprime du hachage tous les éléments pour lesquels le prédicat pred renvoie la valeur "true".

La fonction prend en charge les prédicats qui prennent soit un argument de type QHash<Key, T>::iterator, soit un argument de type std::pair<const Key &, T &>.

Elle renvoie le nombre d'éléments supprimés, le cas échéant.

Cette fonction a été introduite dans Qt 6.1.

Voir aussi clear() et take().

void QHash::reserve(qsizetype size)

Assure que la table de hachage interne de QHash dispose de l'espace nécessaire pour stocker au moins size éléments sans avoir à agrandir la table de hachage.

Cela implique que la table de hachage contienne au moins 2 * size buckets pour garantir de bonnes performances

Cette fonction est utile pour le code qui doit construire une grande table de hachage et qui veut éviter les réallocations répétées. Par exemple :

QHash<QString, int> hash;
hash.reserve(20000);
for (int i = 0; i < 20000; ++i)
    hash.insert(keys[i], values[i]);

Idéalement, size devrait être le nombre maximum d'éléments attendus dans la table de hachage. QHash choisira alors le plus petit nombre possible de godets qui permettra de stocker les éléments size dans la table sans avoir à augmenter la table de hachage interne. Si size est sous-estimé, le pire qui puisse arriver est que QHash soit un peu plus lent.

En général, vous n'aurez que rarement besoin d'appeler cette fonction. QHash En effet, la table de hachage interne d'un système d'exploitation croît automatiquement pour assurer de bonnes performances sans gaspiller trop de mémoire.

Voir également squeeze() et capacity().

[noexcept] qsizetype QHash::size() const

Renvoie le nombre d'éléments dans le hachage.

Voir aussi isEmpty() et count().

void QHash::squeeze()

Réduit la taille de la table de hachage interne de QHash pour économiser de la mémoire.

Le seul but de cette fonction est de fournir un moyen d'affiner l'utilisation de la mémoire de QHash. En général, vous n'aurez que rarement besoin d'appeler cette fonction.

Voir aussi reserve() et capacity().

[noexcept] void QHash::swap(QHash<Key, T> &other)

Échange ce hachage avec other. Cette opération est très rapide et n'échoue jamais.

T QHash::take(const Key &key)

Retire l'élément avec le key du hachage et renvoie la valeur qui lui est associée.

Si l'élément n'existe pas dans le hachage, la fonction renvoie simplement une valeur construite par défaut.

Si vous n'utilisez pas la valeur de retour, remove() est plus efficace.

Voir également remove().

Insère un nouvel élément avec key et une valeur construite à partir de args. Si un élément avec key existe déjà, aucune insertion n'a lieu.

Retourne une instance de TryEmplaceResult, une structure qui contient un iterator vers l'élément nouvellement créé ou vers l'élément préexistant qui a empêché l'insertion, et un booléen, inserted, indiquant si l'insertion a eu lieu.

Par exemple, cela peut être utilisé pour éviter le schéma de comparaison de l'ancienne et de la nouvelle taille ou les doubles recherches. Là où vous auriez pu écrire un code comme :

QHash<int, MyType> hash;
// [...]
int myKey = getKey();
qsizetype oldSize = hash.size();
MyType &elem = hash[myKey];
if (oldSize != hash.size()) // Size changed: new element!
    initialize(elem);
// [use elem...]

vous pouvez écrire à la place :

QHash<int, MyType> hash;
// [...]
int myKey = getKey();
auto result = hash.tryEmplace(myKey);
if (result.inserted) // New element!
    initialize(*result.iterator);
// [use result.iterator...]

Ces fonctions ont été introduites dans Qt 6.9.

Voir aussi emplace(), tryInsert(), et insertOrAssign().

Insère un nouvel élément avec key et une valeur de value. Si un élément avec key existe déjà, aucune insertion n'a lieu.

Retourne une instance de TryEmplaceResult, une structure qui contient un iterator vers l'élément nouvellement créé, ou vers l'élément préexistant qui a empêché l'insertion, et un booléen, inserted, indiquant si l'insertion a eu lieu.

Ces fonctions ont été introduites dans Qt 6.9.

Voir également insert(), tryEmplace() et insertOrAssign().

Insère un nouvel élément avec key et une valeur construite à partir de args. Si un élément avec key existe déjà, l'insertion n'a pas lieu.

Retourne une paire composée d'un itérateur vers l'élément inséré (ou vers l'élément qui a empêché l'insertion), et d'un bool indiquant si l'insertion a eu lieu.

Ces fonctions sont fournies à des fins de compatibilité avec la bibliothèque standard.

Ces fonctions ont été introduites dans Qt 6.9.

Voir aussi emplace(), tryEmplace(), tryInsert() et insertOrAssign().

Insère un nouvel élément avec key et une valeur construite à partir de args. Si un élément avec key existe déjà, l'insertion n'a pas lieu.

Retourne l'itérateur de l'élément inséré, ou l'élément qui a empêché l'insertion.

hint est ignoré.

Ces fonctions sont fournies à des fins de compatibilité avec la bibliothèque standard.

Ces fonctions ont été introduites dans Qt 6.9.

Voir aussi emplace(), tryEmplace(), tryInsert() et insertOrAssign().

Renvoie la valeur associée à key.

Si le hachage ne contient aucun élément avec key, la fonction renvoie defaultValue, ou une valeur construite par défaut si ce paramètre n'a pas été fourni.

QList<T> QHash::values() const

Renvoie une liste contenant toutes les valeurs du hachage, dans un ordre arbitraire.

L'ordre est garanti être le même que celui utilisé par keys().

Cette fonction crée une nouvelle liste en temps linéaire. L'utilisation du temps et de la mémoire que cela implique peut être évitée en itérant de keyValueBegin() à keyValueEnd().

Voir aussi keys() et value().

[noexcept] QHash<Key, T> &QHash::operator=(QHash<Key, T> &&other)

Move-assigne other à cette instance QHash.

[noexcept(...)] QHash<Key, T> &QHash::operator=(const QHash<Key, T> &other)

Affecte other à ce hachage et renvoie une référence à ce hachage.

T &QHash::operator[](const Key &key)

Renvoie la valeur associée à key sous la forme d'une référence modifiable.

Si le hachage ne contient aucun élément avec key, la fonction insère une valeur construite par défaut dans le hachage avec key, et renvoie une référence à cette valeur.

Voir aussi insert() et value().

[noexcept] const T QHash::operator[](const Key &key) const

Identique à value().