Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# Generic Containers

- Introduction
- The Container Classes
- The Iterator Classes

- Java-Style Iterators
- STL-Style Iterators

- The `foreach` Keyword
- Other Container-Like Classes
- Growth Strategies
- Performance Terminology

## Introduction

The Qt library provides a set of general purpose template-based container classes. These classes can be used to store items of a specified type. For example, if you need a resizable array of QStrings, use QVector<QString>.

These container classes are designed to be lighter, safer, and easier to use than the STL containers. If you are unfamiliar with the STL, or prefer to do things the "Qt way", you can use these classes instead of the STL classes.

The container classes are implicitly shared, they are reentrant, and they are optimized for speed, low memory consumption, and minimal inline code expansion, resulting in smaller executables.

For traversing the items stored in a container, you can use one of two types of iterators: Java-style iterators and STL-style iterators. The Java-style iterators are easier to use and provide high-level functionality, whereas the STL-style iterators are slightly more efficient and can be used together with Qt's and STL's generic algorithms.

Qt also offers a foreach keyword that make it very easy to iterate over all the items stored in a container.

## The Container Classes

Qt provides the following container classes:

Class | Summary
--- | ---
QList<T> | This is by far the most commonly used container class. It stores a list of values of a given type (T) that can be accessed by index. Internally, the QList is implemented using an array, ensuring that index-based access is very fast. Items can be added at either end of the list using QList::append() and QList::prepend(), or they can be inserted in the middle using QList::insert(). More than any other container class, QList is highly optimized to expand to as little code as possible in the executable. QStringList inherits from QList<QString>.
QLinkedList<T> | This is similar to QList, except that it uses iterators rather than integer indexes to access items. It also provides better performance than QList when inserting in the middle of a huge list, and it has nicer iterator semantics. (Iterators pointing to an item in a QLinkedList remain valid as long as the item exists, whereas iterators to a QList can become invalid after any insertion or removal.)
QVector<T> | This stores an array of values of a given type at adjacent positions in memory. Inserting at the front or in the middle of a vector can be quite slow, because it can lead to large numbers of items having to be moved by one position in memory.
QStack<T> | This is a convenience subclass of QVector that provides "last in, first out" (LIFO) semantics. It adds the following functions to those already present in QVector: push(), pop(), and top().
QQueue<T> | This is a convenience subclass of QList that provides "first in, first out" (FIFO) semantics. It adds the following functions to those already present in QList: enqueue(), dequeue(), and head().
QMap<Key, T> | This provides a dictionary (associative array) that maps keys of type Key to values of type T. Normally each key is associated with a single value. QMap stores its data in Key order; if order doesn't matter QHash is a faster alternative.
QMultiMap<Key, T> | This is a convenience subclass of QMap that provides a nice interface for multi-valued maps, i.e. maps where one key can be associated with multiple values.
QHash<Key, T> | This has almost the same API as QMap, but provides significantly faster lookups. QHash stores its data in an arbitrary order.
QMultiHash<Key, T> | This is a convenience subclass of QHash that provides a nice interface for multi-valued hashes.

Containers can be nested. For example, it is perfectly possible to use a QMap<QString, QList<int> >, where the key type is QString and the value type QList<int>. The only pitfall is that you must insert a space between the closing angle brackets (>); otherwise the C++ compiler will misinterpret the two >'s as a right-shift operator (>>) and report a syntax error.

The values stored in the various containers can be of any assignable data type. To qualify, a type must provide a default constructor, a copy constructor, and an assignment operator. This covers most data types you are likely to want to store in a container, including basic types such as `int` and `double`, pointer types, and Qt data types such as QString, QDate, and QTime, but it doesn't cover QObject or any QObject subclass (QWidget, QDialog, QTimer, etc.). If you attempt to instantiate a QList<QWidget>, the compiler will complain that QWidget's copy constructor and assignment operators are disabled. If you want to store these kinds of objects in a container, store them as pointers, for example as QList<QWidget *>.

Here's an example custom data type that meets the requirement of an assignable data type:

        class Employee
        {
        public:
            Employee() {}
            Employee(const Employee &other);

            Employee &operator=(const Employee &other);

        private:
            QString myName;
            QDate myDateOfBirth;
        };

If we don't provide a copy constructor or an assignment operator, C++ provides a default implementation that performs a member-by-member copy. In the example above, that would have been sufficient. Also, if you don't provide any constructors, C++ provides a default constructor that initializes its member using default constructors. Although it doesn't provide any explicit constructors or assignment operator, the following data type can be stored in a container:

        struct Movie
        {
            QString title;
            QDate releaseDate;
        };

Some containers have additional requirements for the data types they can store. For example, the Key type of a QMap<Key, T> must provide `operator<()`. Such special requirements are documented in a class's detailed description. In some cases, specific functions have special requirements; these are described on a per-function basis. The compiler will always emit an error if a requirement isn't met.

Qt's containers provide operator<<() and operator>>() so that they can easily be read and written using a QDataStream. This means that the data types stored in the container must also support operator<<() and operator>>(). Providing such support is straightforward; here's how we could do it for the Movie struct above:

        inline QDataStream &operator<<(QDataStream &out, const Movie &movie)
        {
            out << (Q_UINT32)movie.id << movie.title
                << (Q_UINT32)movie.year;
            return out;
        }

        inline QDataStream &operator>>(QDataStream &in, Movie &movie)
        {
            Q_UINT32 id, year;
            in >> id >> movie.title >> year;
            movie.id = (int)id;
            movie.year = (int)year;
            return in;
        }

The documentation of certain container class functions refer to default-constructed values; for example, QVector automatically initializes its items with default-constructed values, and QMap::value() returns a default-constructed value if the specified key isn't in the map. For most value types, this simply means that a value is created using the default constructor (e.g. an empty string for QString). But for built-in types like `int` and `double`, as well as for pointer types, the C++ language doesn't specify any initialization; in those cases, Qt's containers automatically initialize the value to 0.

## The Iterator Classes

Iterators provide a uniform means to access items in a container. Qt's container classes provide two types of iterators: Java-style iterators and STL-style iterators.

### Java-Style Iterators

The Java-style iterators are new in Qt 4.0 and are the standard ones used in Qt applications. They are more convenient to use than the STL-style iterators, at the price of being slightly less efficient. Their API is modelled on Java's iterator classes.

For each container class, there are two Java-style iterator data types: one that provides read-only access and one that provides read-write access.

Containers | Read-only iterator | Read-write iterator
--- | --- | ---
QList<T>, QQueue<T> | QListIterator<T> | QListMutableIterator<T>
QLinkedList<T> | QLinkedListIterator<T> | QLinkedListMutableIterator<T>
QVector<T>, QStack<T> | QVectorIterator<T> | QVectorMutableIterator<T>
QMap<Key, T>, QMultiMap<Key, T> | QMapIterator<Key, T> | QMapMutableIterator<Key, T>
QHash<Key, T>, QMultiHash<Key, T> | QHashIterator<Key, T> | QHashMutableIterator<Key, T>

In this discussion, we will concentrate on QList and QMap. The iterator types for QLinkedList and QVector have exactly the same interface as QList's iterators; similarly, the iterator types for QHash have the same interface as QMap's iterators.

Unlike STL-style iterators (covered below), Java-style iterators point between items rather than directly at items. For this reason, they are either pointing to the very beginning of the container (before the first item), at the very end of the container (after the last item), or between two items. The diagram below shows the valid iterator positions as red arrows for a list containing four items:

Here's a typical loop for iterating through all the elements of a QList<QString> in order and printing them to the console:

        QList<QString> list;
        list << "A" << "B" << "C" << "D";

        QListIterator<QString> i(list);
        while (i.hasNext())
            cout << i.next().ascii() << endl;

It works as follows: The QList to iterate over is passed to the QListIterator constructor. At that point, the iterator is located just in front of the first item in the list (before item "A"). Then we call hasNext() to check whether there is an item after the iterator. If there is, we call next() to jump over that item. The next() function returns the item that it jumps over. For a QList<QString>, that item is of type QString.

Here's how to iterate backward in a QList:

        QListIterator<QString> i(list);
        i.toBack();
        while (i.hasPrevious())
            cout << i.previous().ascii() << endl;

The code is symmetric with iterating forward, except that we start by calling toBack() to move the iterator after the last item in the list.

The diagram below illustrates the effect of calling next() and previous() on an iterator:

The following table summarizes the QListIterator API:

Function | Behavior
--- | ---
toFront() | Moves the iterator to the front of the list (before the first item)
toBack() | Moves the iterator to the back of the list (after the last item)
hasNext() | Returns true if the iterator isn't at the back of the list
next() | Returns the next item and advances the iterator by one position
peekNext() | Returns the next item without moving the iterator
hasPrevious() | Returns true if the iterator isn't at the front of the list
previous() | Returns the previous item and moves the iterator back by one position
peekPrevious() | Returns the previous item without moving the iterator

QListIterator provides no functions to insert or remove items from the list as we iterate. To accomplish this, you must use QListMutableIterator. Here's an example where we remove all odd numbers from a QList<int> using QListMutableIterator:

        QListMutableIterator<int> i(list);
        while (i.hasNext()) {
            if (i.next() % 2 != 0)
                i.remove();
        }

The next() call in the loop is made every time. It jumps over the next item in the list. The remove() function removes the last item that we jumped over from the list. The call to remove() does not invalidate the iterator, so it is safe to continue using it. This works just as well when iterating backward:

        QListMutableIterator<int> i(list);
        i.toBack();
        while (i.hasPrevious()) {
            if (i.previous() % 2 != 0)
                i.remove();
        }

If want just want to modify the value of an existing item, we can use setValue(). In the code below, we replace any value larger than 128 with 128:

        QListMutableIterator<int> i(list);
        while (i.hasNext()) {
            if (i.next() > 128)
                i.setValue(128);
        }

Just like remove(), setValue() operates on the last item that we jumped over. If we iterate forward, this is the item just before the iterator; if we iterate backward, this is the item just after the iterator.

The next() function returns a non-const reference to the item in the list. For simple operations, we don't even need setValue():

        QListMutableIterator<int> i(list);
        while (i.hasNext())
            i.next() *= 2;

As mentioned above, QLinkedList's and QVector's iterator classes have exactly the same API as QList. We will now turn to QMapIterator, which is somewhat different because it iterates on (key, value) pairs.

Like QListIterator, QMapIterator provides toFront(), toBack(), hasNext(), next(), peekNext(), hasPrevious(), previous(), peekPrevious(), and peekPrevious(). The key and value components are extracted by calling key() and value() on the object returned by next(), peekNext(), previous(), or peekPrevious().

The following example removes all (capital, country) pairs where the capital's name ends with "City":

        QMap<QString, QString> map;
        map.insert("Paris", "France");
        map.insert("Guatemala City", "Guatemala");
        map.insert("Mexico City", "Mexico");
        map.insert("Moscow", "Russia");
        ...

        QMapMutableIterator<QString, QString> i(map);
        while (i.hasNext()) {
            if (i.next().key().endsWith("City"))
                i.remove();
        }

QMapIterator also provides a key() and a value() function that operate directly on the iterator and that return the key and value of the last item that the iterator jumped above. For example, the following code copies the contents of a QMap into a QHash:

        QMap<int, QWidget *> map;
        QHash<int, QWidget *> hash;

        QMapIterator<int, QWidget *> i(map);
        while (i.hasNext()) {
            i.next();
            hash.insert(i.key(), i.value());
        }

If we want to iterate through all the items with the same value, we can use findNext() or findPrevious(). Here's an example where we remove all the items with a particular value:

        QMapMutableIterator<int, QWidget *> i(map);
        while (i.findNext(widget))
            i.remove();

Similarly, the findNextKey() or findPreviousKey() functions allow us to iterate through all the items with the same key (for example, in a multi-map):

        QMapMutableIterator<int, QWidget *> i(multimap);
        while (i.findNextKey(-1))
            i.remove();

### STL-Style Iterators

STL-style iterators have been available since the release of Qt 2.0. They are compatible with Qt's and STL's generic algorithms and are optimized for speed.

For each container class, there are two STL-style iterator types: one that provides read-only access and one that provides read-write access. Read-only iterators should be used wherever possible because they are faster than read-write iterators.

Containers | Read-only iterator | Read-write iterator
--- | --- | ---
QList<T>, QQueue<T> | QList<T>::const_iterator | QList<T>::iterator
QLinkedList<T> | QLinkedList<T>::const_iterator | QLinkedList<T>::iterator
QVector<T>, QStack<T> | QVector<T>::const_iterator | QVector<T>::iterator
QMap<Key, T>, QMultiMap<Key, T> | QMap<Key, T>::const_iterator | QMap<Key, T>::iterator
QHash<Key, T>, QMultiHash<Key, T> | QHash<Key, T>::const_iterator | QHash<Key, T>::iterator

The API of the STL iterators is modelled on pointers in an array. For example, the ++ operator advances the iterator to the next item, and the * operator returns the item that the iterator points to. In fact, for QVector and QStack, which store their items at adjacent memory positions, the iterator type is just a typedef for T *, and the const_iterator type is just a typedef for const T *.

In this discussion, we will concentrate on QList and QMap. The iterator types for QLinkedList and QVector have exactly the same interface as QList's iterators; similarly, the iterator types for QHash have the same interface as QMap's iterators.

Here's a typical loop for iterating through all the elements of a QList<QString> in order and converting them to lower-case:

        QList<QString> list;
        list << "A" << "B" << "C" << "D";

        QList<QString>::iterator i;
        for (i = list.begin(); i != list.end(); ++i)
            *i = (*i).toLower();

Unlike Java-style iterators (covered above), STL-style iterators point directly at items. The begin() function of a container returns an iterator that points to the first item in the container. The end() function of a container returns an iterator to the imaginary item one position past the last item in the container. end() marks an invalid position; it must never be dereferenced. It is typically used in a loop's break condition. If the list is empty, begin() equals end(), so we never execute the loop.

The diagram below shows the valid iterator positions as red arrows for a vector containing four items:

Iterating backward with an STL-style iterator requires us to decrement the iterator before we access the item. This requires a `while` loop:

        QList<QString> list;
        list << "A" << "B" << "C" << "D";

        QList<QString>::iterator i = list.end();
        while (i != list.begin()) {
            --i;
            *i = (*i).toLower();
        }

In the code snippets so far, we used the unary `*` operator to retrieve the item (of type QString) stored at a certain iterator position, and we then called QString::toLower() on it. Most C++ compilers also allow us to write `i->toLower()`, but some don't.

For read-only access, you can use const_iterator, constBegin(), and constEnd(). For example:

        QList<QString>::const_iterator i;
        for (i = list.constBegin(); i != list.constEnd(); ++i)
            cout << (*i).ascii() << endl;

The following table summarizes the STL-style iterators' API:

Expression | Behavior
--- | ---
`*i` | Returns the current item
`++i` | Advances the iterator to the next item
`i += n` | Advances the iterator by `n` items
`--i` | Moves the iterator back by one item
`i -= n` | Moves the iterator back by `n` items
`i - j` | Returns the number of items between iterators `i` and `j`

The `++` and `--` operators are available both as prefix (`++i`, `--i`) and postfix (`i++`, `i--`) operators. The prefix versions modify the iterators and return a reference to the modified iterator; the postfix versions take a copy of the iterator before they modify it, and return that copy. In expressions where the return value is ignored, we recommend that you use the prefix operators (`++i`, `--i`), as these are slightly faster.

For non-const iterator types, the return value of the unary `*` operator can be used on the left side of the assignment operator.

For QMap and QHash, the `*` operator returns the value component of an item. If you want to retrieve the key, call key() on the iterator. For symmetry, the iterator types also provide a value() function to retrieve the value. For example, here's how we would print all items in a QMap to the console:

        QMap<int, int> map;
        ...
        QMap<int, int>::const_iterator i;
        for (i = map.constBegin(); i != map.constEnd(); ++i)
            cout << i.key() << ": " << i.value() << endl;

Thanks to implicit sharing, it is very inexpensive for a function to return a container per value. The Qt API contains dozens of functions that return a QList or QStringList per value (e.g. QSplitter::sizes() and QTranslator::messages()). If you want to iterate over these using an STL iterator, you should always take a copy of the container and iterate over the copy. For example:

        // RIGHT
        QList<QTranslatorMessage> messages = translator->messages();
        QList<QTranlatorMessage>::const_iterator i;
        for (i = messages.begin(); i != messages.end(); ++i)
            ...

        // WRONG
        QList<QTranlatorMessage>::const_iterator i;
        for (i = translator->messages().begin();
             i != translator->messages().end(); ++i)
            ...

This problem doesn't occur with functions that return a const or non-const reference to a container.

## The `foreach` Keyword

If you just want to iterate over all the items in a container in order, you can use Qt's `foreach` keyword. The keyword is a Qt-specific addition to the C++ language, and is implemented using the preprocessor.

Its syntax is: `foreach` (variable, container) statement. For example, here's how to use `foreach` to iterate over a QLinkedList<QString>:

        QLinkedList<QString> list;
        ...
        QString str;
        foreach (str, list)
            cout << str.ascii() << endl;

The `foreach` code is significantly shorter than the equivalent code that uses iterators:

        QLinkedList<QString> list;
        ...
        QLinkedListIterator<QString> i(list);
        while (i.hasNext())
            cout << i.next().ascii() << endl;

Just like C++'s `for` loop, the variable used for iteration can be defined within the `foreach` statement:

        QLinkedList<QString> list;
        ...
        foreach (QString str, list)
            cout << str.ascii() << endl;

And like any other C++ loop construct, you can use braces around the body of a `foreach` loop, and you can use `break` to leave the loop:

        QLinkedList<QString> list;
        ...
        foreach (QString str, list) {
            if (str.isEmpty())
                break;
            cout << str.ascii() << endl;
        }

With QMap and QHash, `foreach` accesses the value component of the (key, value) pairs. If you want to iterate over both the keys and the values, you can use iterators (which are fastest), or you can write code like this:

        QMap<QString, int> map;
        ...
        foreach (QString str, map.keys())
            cout << str.ascii() << ": " << map.value(str) << endl;

For a multi-valued map:

        QMultiMap<QString, int> map;
        ...
        foreach (QString str, map.keys())
            foreach (int i, map.values(str))
                cout << str.ascii() << ": " << i << endl;

Qt automatically takes a copy of the container when it enters a `foreach` loop. If you modify the container as you are iterating, that won't affect the loop. (If you don't modify the container, the copy still takes place, but thanks to implicit sharing copying a container is very fast.)

In addition to `foreach`, Qt also provides a `forever` pseudo-keyword for infinite loops:

        forever {
            ...
        }

If you're worried about namespace pollution, you can disable these macros by adding the following line to your .pro file:

        CONFIG += no_keywords

## Other Container-Like Classes

Qt includes three template classes that resemble containers in some respects. These classes don't provide iterators and cannot be used with the `foreach` keyword.

- QVarLengthArray<T, Prealloc> provides a low-level variable-length array. It can be used instead of QVector in places where speed is particularly important.
- QCache<Key, T> provides a cache to store objects of a certain type T associated with keys of type Key.
- QPair<T1, T2> stores a pair of elements.

Additional non-template types that compete with Qt's template containers are QBitArray, QByteArray, QString, and QStringList.

## Growth Strategies

QVector<T>, QString, and QByteArray store their items contiguously in memory; QList<T> maintains an array of pointers to the items it stores to provide fast index-based access (unless T is a pointer type or a basic type of the size of a pointer, in which case the value itself is stored in the array); QHash<Key, T> keeps a hash table whose size is proportional to the number of items in the hash. To avoid reallocating the data every single time an item is added at the end of the container, these classes typically allocate more memory than necessary.

Consider the following code, which builds a QString from another QString:

        QString onlyLetters(const QString &in)
        {
            QString out;
            for (int j = 0; j < in.size(); ++j) {
                if (in[j].isLetter())
                    out += in[j];
            }
            return out;
        }

We build the string `out` dynamically by appending one character to it at a time. Let's assume that we append 15000 characters to the QString string. Then the following 18 reallocations (out of a possible 15000) occur when QString runs out of space: 4, 8, 12, 16, 20, 52, 116, 244, 500, 1012, 2036, 4084, 6132, 8180, 10228, 12276, 14324, 16372. At the end, the QString has 16372 Unicode characters allocated, 15000 of which are occupied.

The values above may seem a bit strange, but here are the guiding priciples:

- QString allocates 4 characters at a time until it reaches size 20.
- From 20 to 4084, it advances by doubling the size each time. More precisely, it advances to the next power of two, minus 12. (Some memory allocators perform worst when requested exact powers of two, because they use a few bytes per block for book-keeping.)
- From 4084 on, it advances by blocks of 2048 characters (4096 bytes). This makes sense because modern operating systems don't copy the entire data when reallocating a buffer; the physical memory pages are simply reordered, and only the data on the first and last pages actually needs to be copied.

QByteArray and QList<T> use more or less the same algorithm as QString.

QVector<T> also uses that algorithm for data types that can be moved around in memory using memcpy() (including the basic C++ types, the pointer types, and Qt's shared classes) but uses a different algorithm for data types that can only be moved by calling the copy constructor and a destructor. Since the cost of reallocating is higher in that case, QVector<T> reduces the number of reallocations by always doubling the memory when running out of space.

QHash<Key, T> is a totally different case. QHash's internal hash table grows by powers of two, and each time it grows, the items are relocated in a new bucket, computed as qHash(key) % QHash::capacity() (the number of buckets).

For most applications, the default growing algorithm provided by Qt does the trick. If you need more control, QVector<T>, QHash<Key, T>, QString, and QByteArray provide a trio of functions that allow you to check and specify how much memory to use to store the items:

- capacity() returns the number of items for which memory is allocated (for QHash, the number of buckets in the hash table).
- reserve(size) explicitly preallocates memory for size items.
- squeeze() frees any memory not required to store the items.

If you know approximately how many items you will store in a container, you can start by calling reserve(), and when you are done populating the container, you can call squeeze() to release the extra preallocated memory.

## Performance Terminology

The containers documentation provides information about how fast (or slow) each function is as the number of items in the container grow. For example, inserting an item in the middle of a QLinkedList is an extremely fast operation, irrespective of the number of items stored in the QLinkedList. On the other hand, inserting an item in the middle of a QVector is potentially very expensive if the QVector contains many items, since half of the items must be moved one position in memory.

In the documentation, we use the following terminology, based on the "big Oh" notation:

- constant time: O(1). A function is said to run in constant time if it requires the same amount of time no matter how many items are present in the container. One example is QLinkedList::insert().
- logarithmic time: O(log n). A function that runs in logarithmic time is a function whose running time is proportional to the logarithm of the number of items in the container. One example is qBinaryFind().
- linear time: O(n). A function that runs in linear time will execute in a time directly proportional to the number of items stored in the container. One example is QVector::insert().
- linear-logarithmic time: O(n log n). A function that runs in linear-logarithmic time is asymptotically slower than a linear-time function, but faster than a quadratic-time function.
- quadratic time: O(n^2). A quadratic-time function executes in a time that is proportional to the square of the number of items stored in the container.