Back to Doc.qt.io
Contact Us Blog Download Qt

QMultiMap::const_iterator Class

class QMultiMap::const_iterator

The QMultiMap::const_iterator class provides an STL-style const iterator for QMultiMap. More...

Public Types

iterator_category

Public Functions

const_iterator()
const_iterator(const QMultiMap<Key, T>::iterator &other)
const Key &key() const
const T &value() const
const T &operator*() const
QMultiMap<Key, T>::const_iterator &operator++()
QMultiMap<Key, T>::const_iterator operator++(int)
QMultiMap<Key, T>::const_iterator &operator--()
QMultiMap<Key, T>::const_iterator operator--(int)
const T *operator->() const
bool operator!=(const QMultiMap<Key, T>::const_iterator &lhs, const QMultiMap<Key, T>::const_iterator &rhs)
bool operator==(const QMultiMap<Key, T>::const_iterator &lhs, const QMultiMap<Key, T>::const_iterator &rhs)

Detailed Description

QMultiMap<Key, T>::const_iterator allows you to iterate over a QMultiMap. If you want to modify the QMultiMap as you iterate over it, you must use QMultiMap::iterator instead. It is generally good practice to use QMultiMap::const_iterator on a non-const QMultiMap as well, unless you need to change the QMultiMap through the iterator. Const iterators are slightly faster, and can improve code readability.

The default QMultiMap::const_iterator constructor creates an uninitialized iterator. You must initialize it using a QMultiMap function like QMultiMap::cbegin(), QMultiMap::cend(), or QMultiMap::constFind() before you can start iterating. Here's a typical loop that prints all the (key, value) pairs stored in a map:

QMultiMap<QString, int> multi;
multimap.insert("January", 1);
multimap.insert("February", 2);
...
multimap.insert("December", 12);

for (auto i = multimap.cbegin(), end = multimap.cend(); i != end; ++i)
    cout << qPrintable(i.key()) << ": " << i.value() << endl;

Here's an example that removes all the items whose value is greater than 10:

QMultiMap<QString, int>::const_iterator i = multimap.cbegin();
while (i != multimap.cend()) {
    if (i.value() > 10)
        i = multimap.erase(i);
    else
        ++i;
}

Unlike QMultiHash, which stores its items in an arbitrary order, QMultiMap stores its items ordered by key. Items that share the same key will appear consecutively, from the most recently to the least recently inserted value.

Multiple iterators can be used on the same multi map. If you add items to the map, existing iterators will remain valid. If you remove items from the map, iterators that point to the removed items will become dangling iterators.

Warning: Iterators on implicitly shared containers do not work exactly like STL-iterators. You should avoid copying a container while iterators are active on that container. For more information, read Implicit sharing iterator problem.

See also QMultiMap::iterator, QMultiMap::key_iterator, and QMultiMap::const_key_value_iterator.

Member Type Documentation

[alias] const_iterator::iterator_category

A synonym for std::bidirectional_iterator_tag indicating this iterator is a bidirectional iterator.

Member Function Documentation

const_iterator::const_iterator()

Constructs an uninitialized iterator.

Functions like key(), value(), and operator++() must not be called on an uninitialized iterator. Use operator=() to assign a value to it before using it.

See also QMultiMap::constBegin() and QMultiMap::constEnd().

const_iterator::const_iterator(const QMultiMap<Key, T>::iterator &other)

Constructs a copy of other.

const Key &const_iterator::key() const

Returns the current item's key.

See also value().

const T &const_iterator::value() const

Returns the current item's value.

See also key() and operator*().

const T &const_iterator::operator*() const

Returns the current item's value.

Same as value().

See also key().

QMultiMap<Key, T>::const_iterator &const_iterator::operator++()

The prefix ++ operator (++i) advances the iterator to the next item in the map and returns an iterator to the new current item.

Calling this function on QMultiMap::end() leads to undefined results.

See also operator--().

QMultiMap<Key, T>::const_iterator const_iterator::operator++(int)

This is an overloaded function.

The postfix ++ operator (i++) advances the iterator to the next item in the map and returns an iterator to the previously current item.

QMultiMap<Key, T>::const_iterator &const_iterator::operator--()

The prefix -- operator (--i) makes the preceding item current and returns an iterator pointing to the new current item.

Calling this function on QMultiMap::begin() leads to undefined results.

See also operator++().

QMultiMap<Key, T>::const_iterator const_iterator::operator--(int)

This is an overloaded function.

The postfix -- operator (i--) makes the preceding item current and returns an iterator pointing to the previously current item.

const T *const_iterator::operator->() const

Returns a pointer to the current item's value.

See also value().

Related Non-Members

bool operator==(const QMultiMap<Key, T>::const_iterator &lhs, const QMultiMap<Key, T>::const_iterator &rhs)

Returns true if lhs points to the same item as the rhs iterator; otherwise returns false.

See also operator!=().

bool operator!=(const QMultiMap<Key, T>::const_iterator &lhs, const QMultiMap<Key, T>::const_iterator &rhs)

Returns true if lhs points to a different item than the rhs iterator; otherwise returns false.

See also operator==().

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.