QMutableVectorIterator Class

The QMutableVectorIterator class provides a Java-style non-const iterator for QVector and QStack. More...

Header: #include <QMutableVectorIterator>
qmake: QT += core

Public Functions

QMutableVectorIterator(QVector<T> &vector)
QMutableVectorIterator<T> &operator=(QVector<T> &container)
bool findNext(const T &value)
bool findPrevious(const T &value)
bool hasNext() const
bool hasPrevious() const
void insert(const T &value)
T &next()
T &peekNext() const
T &peekPrevious() const
T &previous()
void remove()
void setValue(const T &value) const
void toBack()
void toFront()
const T &value() const
T &value()

Detailed Description

QVector has both Java-style iterators and STL-style iterators. The Java-style iterators are more high-level and easier to use than the STL-style iterators; on the other hand, they are slightly less efficient.

An alternative to using iterators is to use index positions. Most QVector member functions take an index as their first parameter, making it possible to access, insert, and remove items without using iterators.

QMutableVectorIterator<T> allows you to iterate over a QVector<T> and modify the vector. If you don't want to modify the vector (or have a const QVector), use the slightly faster QVectorIterator<T> instead.

The QMutableVectorIterator constructor takes a QVector as argument. After construction, the iterator is located at the very beginning of the list (before the first item). Here's how to iterate over all the elements sequentially:

QVector<float> vector;
...
QMutableVectorIterator<float> i(vector);
while (i.hasNext())
    qDebug() << i.next();

The next() function returns the next item in the vector and advances the iterator. Unlike STL-style iterators, Java-style iterators point between items rather than directly at items. The first call to next() advances the iterator to the position between the first and second item, and returns the first item; the second call to next() advances the iterator to the position between the second and third item, returning the second item; and so on.

Here's how to iterate over the elements in reverse order:

QMutableVectorIterator<float> i(vector);
i.toBack();
while (i.hasPrevious())
    qDebug() << i.previous();

If you want to find all occurrences of a particular value, use findNext() or findPrevious() in a loop.

If you want to remove items as you iterate over the vector, use remove(). If you want to modify the value of an item, use setValue(). If you want to insert a new item in the vector, use insert().

Example:

QMutableVectorIterator<int> i(vector);
while (i.hasNext()) {
    int val = i.next();
    if (val < 0) {
        i.setValue(-val);
    } else if (val == 0) {
        i.remove();
    }
}

The example traverses a vector, replacing negative numbers with their absolute values, and eliminating zeroes.

Only one mutable iterator can be active on a given vector at any time. Furthermore, no changes should be done directly to the vector while the iterator is active (as opposed to through the iterator), since this could invalidate the iterator and lead to undefined behavior.

See also QVectorIterator and QVector::iterator.

Member Function Documentation

void QMutableVectorIterator::remove()

Removes the last item that was jumped over using one of the traversal functions (next(), previous(), findNext(), findPrevious()).

Example:

QMutableVectorIterator<int> i(vector);
while (i.hasNext()) {
    int val = i.next();
    if (val < -32768 || val > 32767)
        i.remove();
}

See also insert() and setValue().

void QMutableVectorIterator::setValue(const T &value) const

Replaces the value of the last item that was jumped over using one of the traversal functions with value.

The traversal functions are next(), previous(), findNext(), and findPrevious().

Example:

QMutableVectorIterator<double> i(list);
while (i.hasNext()) {
    double val = i.next();
    i.setValue(std::sqrt(val));
}

See also value(), remove(), and insert().

© 2019 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.