QMap Class

Documentation des fonctions membres

[default] QMap::QMap()

Crée un map vide.

Voir aussi clear().

[explicit] QMap::QMap(const std::map<Key, T> &other)

Crée une copie de other.

Voir également toStdMap().

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

Crée une carte contenant une copie de chacun des éléments de la liste d'initialisation list.

[explicit] QMap::QMap(std::map<Key, T> &&other)

Crée une carte à partir de other.

Voir aussi toStdMap().

[implicit] QMap::QMap(const QMap<Key, T> &other)

Crée une copie de other.

Cette opération s'effectue en temps constant, car le QMap est implicitement partagé. Cela rend très rapide le retour d'un QMap depuis une fonction. Si une instance partagée est modifiée, elle sera copiée (copie à l'écriture), ce qui prend un temps linéaire.

Voir également operator=.

[implicit] QMap::QMap(QMap<Key, T> &&other)

Crée une instance de QMap par copie.

[implicit] QMap::~QMap()

Supprime la table. Les références aux valeurs contenues dans la table, ainsi que tous les itérateurs sur cette table, deviennent invalides.

Renvoie un objet « range » qui permet de parcourir cette carte sous forme de paires clé/valeur. Par exemple, cet objet « range » peut être utilisé dans une boucle « for » basée sur une plage, en combinaison avec une déclaration de liaison structurée :

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

for (auto [key, value] : map.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 toutes deux des références à celles contenues dans la carte. Plus précisément, la modification de la valeur entraînera une modification de la carte elle-même.

Ces fonctions ont été introduites dans Qt 6.4.

Voir également QKeyValueIterator.

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

Renvoie un itérateur de type STL pointant vers le premier élément de la table.

Voir également constBegin() et end().

QMap<Key, T>::const_iterator QMap::begin() const

QMap<Key, T>::const_iterator QMap::cbegin() const

Renvoie un itérateur de type STL constant pointant vers le premier élément de la table.

Voir également begin() et cend().

QMap<Key, T>::const_iterator QMap::cend() const

Renvoie un itérateur de type STL (const) pointant vers l'élément imaginaire situé après le dernier élément de la table.

Voir également cbegin() et end().

void QMap::clear()

Supprime tous les éléments de la carte.

Voir aussi remove().

QMap<Key, T>::const_iterator QMap::constBegin() const

Renvoie un itérateur const de type STL pointant vers le premier élément de la table.

Voir également ` begin()` et ` constEnd()`.

QMap<Key, T>::const_iterator QMap::constEnd() const

Renvoie un itérateur de type STL (const) pointant vers l'élément imaginaire situé après le dernier élément de la table.

Voir également constBegin() et end().

QMap<Key, T>::const_iterator QMap::constFind(const Key &key) const

Renvoie un itérateur `const` pointant vers l'élément de la carte dont la clé est ` key `.

Si la table ne contient aucun élément avec la clé « key », la fonction renvoie « constEnd »().

Voir aussi find().

QMap<Key, T>::const_key_value_iterator QMap::constKeyValueBegin() const

Renvoie un itérateur de type STL (const) pointant vers la première entrée de la table.

Voir aussi keyValueBegin().

QMap<Key, T>::const_key_value_iterator QMap::constKeyValueEnd() const

Renvoie un itérateur de type STL (const) pointant vers l'entrée imaginaire située après la dernière entrée de la table.

Voir aussi ` constKeyValueBegin()`.

bool QMap::contains(const Key &key) const

Renvoie « true » si la carte contient un élément dont la clé est « key » ; sinon, renvoie « false ».

Voir également count().

QMap<Key, T>::size_type QMap::count(const Key &key) const

Renvoie le nombre d'éléments associés à la clé « key ».

Voir aussi contains().

QMap<Key, T>::size_type QMap::count() const

Identique à ` size()`.

bool QMap::empty() const

Cette fonction est fournie à des fins de compatibilité avec la STL. Elle équivaut à ` isEmpty()`, qui renvoie `true` si la table est vide ; sinon, elle renvoie `false`.

QMap<Key, T>::iterator QMap::end()

Renvoie un itérateur de type STL pointant vers l'élément imaginaire situé après le dernier élément de la table.

Voir également begin() et constEnd().

QMap<Key, T>::const_iterator QMap::end() const

std::pair<QMap<Key, T>::iterator, QMap<Key, T>::iterator> QMap::equal_range(const Key &key)

Renvoie une paire d'itérateurs délimitant l'intervalle de valeurs [first, second), qui sont stockées sous key.

std::pair<QMap<Key, T>::const_iterator, QMap<Key, T>::const_iterator> QMap::equal_range(const Key &key) const

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

Supprime de la carte la paire (clé, valeur) pointée par l'itérateur pos, puis renvoie un itérateur vers l'élément suivant de la carte.

Voir aussi remove().

[since 6.0] QMap<Key, T>::iterator QMap::erase(QMap<Key, T>::const_iterator first, QMap<Key, T>::const_iterator last)

Supprime de la carte les paires (clé, valeur) pointées par la plage d'itérateurs [first, last). Renvoie un itérateur vers l'élément de la carte suivant le dernier élément supprimé.

Cette fonction a été introduite dans Qt 6.0.

Voir aussi remove().

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

Renvoie un itérateur pointant vers l'élément de la carte dont la clé est « key ».

Si la table ne contient aucun élément avec la clé « key », la fonction renvoie « end »().

Voir également constFind(), value(), values(), lowerBound() et upperBound().

QMap<Key, T>::const_iterator QMap::find(const Key &key) const

T &QMap::first()

Renvoie une référence à la première valeur de la table, c'est-à-dire la valeur associée à la clé la plus petite. Cette fonction suppose que la table n'est pas vide.

Lorsqu’elle n’est pas partagée (ou que la version `const` est appelée), cette fonction s’exécute en temps constant.

Voir également last(), firstKey() et isEmpty().

const T &QMap::first() const

const Key &QMap::firstKey() const

Renvoie une référence à la plus petite clé de la carte. Cette fonction suppose que la carte n'est pas vide.

Cette opération s'exécute en temps constant.

Voir également lastKey(), first(), keyBegin() et isEmpty().

void QMap::insert(QMap<Key, T> &&map)

Déplace tous les éléments de map vers cette carte.

Si une clé est commune aux deux cartes, sa valeur sera remplacée par celle stockée dans map.

Si map est partagée, les éléments seront alors copiés.

void QMap::insert(const QMap<Key, T> &map)

Insère tous les éléments de map dans cette carte.

Si une clé est commune aux deux cartes, sa valeur sera remplacée par celle stockée dans map.

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

Insère un nouvel élément avec la clé « key » et la valeur « value ».

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

L’insertion d’une paire clé/valeur avec une clé existante remplace la valeur existante.

Renvoie un itérateur pointant vers l'élément nouveau ou mis à jour.

QMap<Key, T>::iterator QMap::insert(QMap<Key, T>::const_iterator pos, const Key &key, const T &value)

Insère un nouvel élément avec la clé key, la valeur value et l'indication pos précisant où effectuer l'insertion.

Si constBegin() est utilisé comme indice, cela indique que key est inférieur à toutes les clés de la carte, tandis que constEnd() suggère que key est (strictement) supérieur à toutes les clés de la carte. Sinon, l’indication doit satisfaire la condition (pos - 1).key() < key <= pos.key(). Si l’indication pos est erronée, elle est ignorée et une insertion normale est effectuée.

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

Si l’indication est correcte et que la table n’est pas partagée, l’insertion s’exécute en temps constant amorti.

Lors de la création d’une carte à partir de données triées, l’insertion de la plus grande clé en premier avec ` constBegin()` est plus rapide que l’insertion dans l’ordre trié avec ` constEnd()`, car ` constEnd()` - 1 (nécessaire pour vérifier si l’indication est valide) nécessite un temps logarithmique.

Remarque : soyez prudent avec l’indication. Fournir un itérateur provenant d’une ancienne instance partagée peut provoquer un plantage, mais il existe également un risque que cela corrompe silencieusement à la fois la carte et la carte pos.

Renvoie un itérateur pointant vers l’élément nouveau/mis à jour.

bool QMap::isEmpty() const

Renvoie ` true ` si la carte ne contient aucun élément ; sinon, renvoie `false`.

Voir également size().

Key QMap::key(const T &value, const Key &defaultKey = Key()) const

Renvoie la première clé dont la valeur est value, ou defaultKey si la table ne contient aucun élément dont la valeur est value. Si aucune defaultKey n'est fournie, la fonction renvoie une clé construite par défaut.

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

Voir également value() et keys().

QMap<Key, T>::key_iterator QMap::keyBegin() const

Renvoie un itérateur de type STL (const) pointant vers la première clé de la table.

Voir également keyEnd() et firstKey().

QMap<Key, T>::key_iterator QMap::keyEnd() const

Renvoie un itérateur de type STL (const) pointant vers l'élément imaginaire situé après la dernière clé de la table.

Voir aussi keyBegin() et lastKey().

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

Renvoie un itérateur de type STL pointant vers la première entrée de la table.

Voir aussi ` keyValueEnd()`.

QMap<Key, T>::const_key_value_iterator QMap::keyValueBegin() const

Renvoie un itérateur constant de type STL pointant vers la première entrée de la table.

Voir également keyValueEnd().

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

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

Voir aussi ` keyValueBegin()`.

QMap<Key, T>::const_key_value_iterator QMap::keyValueEnd() const

Renvoie un itérateur const de type STL pointant vers l'entrée imaginaire située après la dernière entrée de la table.

Voir également keyValueBegin().

QList<Key> QMap::keys() const

Renvoie une liste contenant toutes les clés de la table, classées par ordre croissant.

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

Cette fonction crée une nouvelle liste, en temps linéaire. La consommation de temps et de mémoire que cela implique peut être évitée en itérant de ` keyBegin()` à ` keyEnd()`.

Voir également values() et key().

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

Renvoie une liste contenant toutes les clés associées à la valeur value, classées par ordre croissant.

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

T &QMap::last()

Renvoie une référence à la dernière valeur de la table, c'est-à-dire la valeur associée à la clé la plus grande. Cette fonction suppose que la table n'est pas vide.

Lorsqu’elle est appelée en mode non partagé (ou dans sa version `const`), cette fonction s’exécute en temps constant.

Voir également first(), lastKey() et isEmpty().

const T &QMap::last() const

const Key &QMap::lastKey() const

Renvoie une référence à la clé la plus grande de la table. Cette fonction suppose que la table n'est pas vide.

Cette opération s'exécute en temps constant.

Voir également firstKey(), last(), keyEnd() et isEmpty().

QMap<Key, T>::iterator QMap::lowerBound(const Key &key)

Renvoie un itérateur pointant vers le premier élément de la carte dont la clé est key. Si la carte ne contient aucun élément dont la clé est key, la fonction renvoie un itérateur pointant vers l'élément le plus proche dont la clé est supérieure.

Voir également upperBound() et find().

QMap<Key, T>::const_iterator QMap::lowerBound(const Key &key) const

QMap<Key, T>::size_type QMap::remove(const Key &key)

Supprime tous les éléments de la carte dont la clé est « key ». Renvoie le nombre d'éléments supprimés : 1 si la clé existe dans la carte, et 0 dans le cas contraire.

Voir aussi clear() et take().

[since 6.1] template <typename Predicate> QMap<Key, T>::size_type QMap::removeIf(Predicate pred)

Supprime de la carte tous les éléments pour lesquels le prédicat pred renvoie « vrai ».

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

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

Cette fonction a été introduite dans Qt 6.1.

Voir également clear() et take().

QMap<Key, T>::size_type QMap::size() const

Renvoie le nombre de paires (clé, valeur) contenues dans la table.

Voir également isEmpty() et count().

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

Permutera cette carte avec celle de other. Cette opération est très rapide et ne pose jamais de problème.

T QMap::take(const Key &key)

Supprime l'élément associé à la clé « key » de la carte et renvoie la valeur qui lui est associée.

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

Si vous n'utilisez pas la valeur renvoyée, la fonction ` remove()` est plus efficace.

Voir aussi remove().

std::map<Key, T> QMap::toStdMap() const &

Renvoie une carte STL équivalente à celle-ci : QMap.

[since 6.0] std::map<Key, T> QMap::toStdMap() &&

Cette fonction a été introduite dans Qt 6.0.

QMap<Key, T>::iterator QMap::upperBound(const Key &key)

Renvoie un itérateur pointant vers l'élément qui suit immédiatement le dernier élément de la carte dont la clé est « key ». Si la carte ne contient aucun élément dont la clé est « key », la fonction renvoie un itérateur pointant vers l'élément le plus proche dont la clé est supérieure.

Exemple :

QMap<int, QString> map;
map.insert(1, "one");
map.insert(5, "five");
map.insert(10, "ten");

map.upperBound(0);      // returns iterator to (1, "one")
map.upperBound(1);      // returns iterator to (5, "five")
map.upperBound(2);      // returns iterator to (5, "five")
map.upperBound(10);     // returns end()
map.upperBound(999);    // returns end()

Voir également lowerBound() et find().

QMap<Key, T>::const_iterator QMap::upperBound(const Key &key) const

T QMap::value(const Key &key, const T &defaultValue = T()) const

Renvoie la valeur associée à la clé « key ».

Si la table ne contient aucun élément avec la clé key, la fonction renvoie defaultValue. Si aucun defaultValue n’est spécifié, la fonction renvoie une valeur construite par défaut.

Voir également key(), values(), contains() et operator[]().

QList<T> QMap::values() const

Renvoie une liste contenant toutes les valeurs de la carte, classées par ordre croissant de leurs clés.

Cette fonction crée une nouvelle liste, en temps linéaire. La consommation de temps et de mémoire que cela implique peut être évitée en itérant de ` keyValueBegin()` à ` keyValueEnd()`.

Voir également keys() et value().

[implicit] QMap<Key, T> &QMap::operator=(QMap<Key, T> &&other)

Cette opération attribue l'other à cette instance QMap.

[implicit] QMap<Key, T> &QMap::operator=(const QMap<Key, T> &other)

Attribue la méthode « other » à cette carte et renvoie une référence à celle-ci.

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

Renvoie la valeur associée à la clé key sous forme de référence modifiable.

Si la carte ne contient aucun élément avec la clé « key », la fonction insère une valeur construite par défaut dans la carte avec la clé « key », puis renvoie une référence à celle-ci.

Voir également insert() et value().

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

Identique à ` value()`.