QMap Class

Documentation des fonctions membres

QMap::QMap()

Construit une carte vide.

Voir aussi clear().

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

Construit une copie de other.

Voir aussi toStdMap().

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

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

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

Construit une carte en se déplaçant à partir de other.

Voir aussi toStdMap().

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

Construit une copie de other.

Cette opération s'effectue en temps constant, car la QMap est implicitement partagée. Le retour d'une QMap à partir d'une fonction est donc 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 aussi operator=.

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

Move-construit une instance de QMap.

[default] QMap::~QMap()

Détruit la carte. Les références aux valeurs de la carte et tous les itérateurs sur cette carte deviennent invalides.

Renvoie un objet de plage qui permet d'itérer sur cette carte 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 :

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 des références à celles de la carte. Plus précisément, la modification de la valeur modifiera la carte elle-même.

Ces fonctions ont été introduites dans Qt 6.4.

Voir aussi QKeyValueIterator.

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

Renvoie un itérateur de style STL pointant sur le premier élément de la carte.

Voir aussi constBegin() et end().

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

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

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

Voir aussi begin() et cend().

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

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

Voir aussi 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 constant de style STL pointant sur le premier élément de la carte.

Voir aussi begin() et constEnd().

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

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

Voir aussi constBegin() et end().

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

Renvoie un itérateur constant pointant vers l'élément avec la clé key dans la carte.

Si la carte 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 constant de style STL pointant sur la première entrée de la carte.

Voir aussi keyValueBegin().

QMap<Key, T>::const_key_value_iterator QMap::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 de la carte.

Voir aussi constKeyValueBegin().

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

Renvoie true si la carte contient un élément avec la clé key; sinon, renvoie false.

Voir aussi 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 pour la compatibilité STL. Elle est équivalente à isEmpty() et renvoie la valeur true si la carte est vide, sinon elle renvoie la valeur false.

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

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

Voir aussi 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 la plage 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) indiquée par l'itérateur pos et 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) désignées par l'itérateur [first, last). Renvoie un itérateur vers l'élément de la carte qui suit 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 avec la clé key dans la carte.

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

Voir aussi 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 carte, c'est-à-dire la valeur associée à la plus petite clé. Cette fonction suppose que la carte n'est pas vide.

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

Voir aussi 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.

Elle s'exécute en temps constant.

Voir aussi lastKey(), first(), keyBegin() et isEmpty().

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

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

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

Si map est partagé, les éléments seront copiés à la place.

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 la valeur 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.

Retourne un itérateur pointant vers l'élément nouveau/mise à 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 et la valeur value et avec l'indice pos suggérant où effectuer l'insertion.

Si constBegin() est utilisé comme indice, il indique que key est inférieur à n'importe quelle clé de la carte, tandis que constEnd() suggère que key est (strictement) supérieur à n'importe quelle clé de la carte. Sinon, l'indice doit remplir la condition (pos - 1).key() < key <= pos.key(). Si l'indice pos est erroné, il est ignoré 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'indice est correct et que la carte n'est pas partagée, l'insertion s'exécute en un 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(), puisque constEnd() - 1 (qui est nécessaire pour vérifier si l'indice est valide) nécessite un temps logarithmique.

Remarque : soyez prudent avec l'indice. Fournir un itérateur provenant d'une ancienne instance partagée peut provoquer un crash, mais il y a aussi le risque de corrompre silencieusement à la fois la carte et la carte pos.

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

bool QMap::isEmpty() const

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

Voir aussi size().

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

Renvoie la première clé avec la valeur value, ou defaultKey si la carte ne contient aucun élément avec la valeur value. Si aucun defaultKey n'est fourni, 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 aussi value() et keys().

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

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

Voir aussi keyEnd() et firstKey().

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

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

Voir aussi keyBegin() et lastKey().

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

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

Voir aussi keyValueEnd().

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

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

Voir aussi keyValueEnd().

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

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

Voir aussi keyValueBegin().

QMap<Key, T>::const_key_value_iterator QMap::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 de la carte.

Voir aussi keyValueBegin().

QList<Key> QMap::keys() const

Renvoie une liste contenant toutes les clés de la carte dans l'ordre croissant.

L'ordre est garanti comme étant 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> QMap::keys(const T &value) const

Renvoie une liste contenant toutes les clés associées à la valeur value dans l'ordre croissant.

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.

T &QMap::last()

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

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

Voir aussi first(), lastKey() et isEmpty().

const T &QMap::last() const

const Key &QMap::lastKey() const

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

Elle s'exécute en temps constant.

Voir aussi firstKey(), last(), keyEnd() et isEmpty().

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

Renvoie un itérateur pointant vers le premier élément avec la clé key dans la carte. Si la carte ne contient aucun élément avec la clé key, la fonction renvoie un itérateur vers l'élément le plus proche avec une clé plus grande.

Voir aussi 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 de la carte tous les éléments ayant la clé key. Renvoie le nombre d'éléments supprimés, qui sera égal à 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 la valeur "true".

La fonction prend en charge les prédicats qui prennent soit un argument de type QMap<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().

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

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

Voir aussi isEmpty() et count().

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

Remplace cette carte par other. Cette opération est très rapide et n'échoue jamais.

T QMap::take(const Key &key)

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

Si l'élément n'existe pas dans la carte, 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().

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

Retourne une carte STL équivalente à cette 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 avec la clé key dans la carte. Si la carte ne contient aucun élément avec la clé key, la fonction renvoie un itérateur vers l'élément le plus proche avec une clé plus grande.

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 aussi 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 carte 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 aussi key(), values(), contains() et operator[]().

QList<T> QMap::values() const

Renvoie une liste contenant toutes les valeurs de la carte, dans l'ordre croissant de leurs clés.

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().

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

Move-assigne other à cette instance QMap.

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

Attribue other à cette carte et renvoie une référence à cette carte.

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

Renvoie la valeur associée à la clé key sous la forme d'une 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, et renvoie une référence à cette valeur.

Voir aussi insert() et value().

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

Identique à value().