<QtAlgorithms> - Generic Algorithms

Random Access Iterators

The last category, random access iterators, is the most powerful type of iterator. It supports all the requirements of a bidirectional iterator, and supports the following operations:

QList, QLinkedList, and QVector's non-const iterator types are random access iterators.

See also container classes and <QtGlobal>.

Function Documentation

RandomAccessIterator qBinaryFind ( RandomAccessIterator begin, RandomAccessIterator end, const T & value )

Performs a binary search of the range [begin, end) and returns the position of an occurrence of value. If there are no occurrences of value, returns end.

The items in the range [begin, end) must be sorted in ascending order; see qSort().

If there are many occurrences of the same value, any one of them could be returned. Use qLowerBound() or qUpperBound() if you need finer control.

Example:

    QVector<int> vect;
    vect << 3 << 3 << 6 << 6 << 6 << 8;

    QVector<int>::Iterator i =
            qBinaryFind(vect.begin(), vect.end(), 6);
    // i == vect.begin() + 2 (or 3 or 4)

This function requires the item type (in the example above, QString) to implement operator<().

See the detailed description for an example usage.

See also qLowerBound(), qUpperBound(), and random access iterators.

OutputIterator qCopy ( InputIterator begin1, InputIterator end1, OutputIterator begin2 )

Copies the items from range [begin1, end1) to range [begin2, ...), in the order in which they appear.

The item at position begin1 is assigned to that at position begin2; the item at position begin1 + 1 is assigned to that at position begin2 + 1; and so on.

Example:

    QList<QString> list;
    list << "one" << "two" << "three";

    QVector<QString> vect1(3);
    qCopy(list.begin(), list.end(), vect1.begin());
    // vect: [ "one", "two", "three" ]

    QVector<QString> vect2(8);
    qCopy(list.begin(), list.end(), vect2.begin() + 2);
    // vect: [ "", "", "one", "two", "three", "", "", "" ]

See also qCopyBackward(), input iterators, and output iterators.

BiIterator2 qCopyBackward ( BiIterator1 begin1, BiIterator1 end1, BiIterator2 end2 )

Copies the items from range [begin1, end1) to range [..., end2).

The item at position end1 - 1 is assigned to that at position end2 - 1; the item at position end1 - 2 is assigned to that at position end2 - 2; and so on.

Example:

    QList<QString> list;
    list << "one" << "two" << "three";

    QVector<QString> vect(5);
    qCopyBackward(list.begin(), list.end(), vect.end());
    // vect: [ "", "", "one", "two", "three" ]

See also qCopy() and bidirectional iterators.

void qCount ( InputIterator begin, InputIterator end, const T & value, Size & n )

Sets n to the number of occurrences of value in the range [begin, end).

Example:

    QList<int> list;
    list << 3 << 3 << 6 << 6 << 6 << 8;

    int countOf6;
    qCount(list.begin(), list.end(), 6, countOf6);
    // countOf6 == 3

    int countOf7;
    qCount(list.begin(), list.end(), 7, countOf7);
    // countOf7 == 0

This function requires the item type (in the example above, int) to implement operator==().

See also input iterators.

void qDeleteAll ( ForwardIterator begin, ForwardIterator end )

Deletes all the items in the range [begin, end) using the C++ delete operator. The item type must be a pointer type (for example, QWidget *).

Example:

    QList<Employee *> list;
    list.append(new Employee("Blackpool", "Stephen"));
    list.append(new Employee("Twist", "Oliver"));

    qDeleteAll(list.begin(), list.end());
    list.clear();

Notice that qDeleteAll() doesn't remove the items from the container; it merely calls delete on them. In the example above, we call clear() on the container to remove the items.

See also forward iterators.

void qDeleteAll ( const Container & c )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

This is the same as qDeleteAll(c.begin(), c.end()).

bool qEqual ( InputIterator1 begin1, InputIterator1 end1, InputIterator2 begin2 )

Compares the items in the range [begin1, end1) with the items in the range [begin2, ...). Returns true if all the items compare equal; otherwise returns false.

Example:

    QList<QString> list;
    list << "one" << "two << "three";

    QVector<QString> vect[3];
    vect[0] = "one";
    vect[1] = "two";
    vect[2] = "three";

    bool ret1 = qEqual(list.begin(), list.end(), vect.begin());
    // ret1 == true

    vect[2] = "seven";
    bool rec2 = qEqual(list.begin(), list.end(), vect.begin());
    // ret2 == false

This function requires the item type (in the example above, QString) to implement operator==().

See also input iterators.

void qFill ( ForwardIterator begin, ForwardIterator end, const T & value )

Fills the range [begin, end) with value.

Example:

    QList<QString> list;
    list << "one" << "two" << "three";

    qFill(list.begin(), list.end(), "eleven");
    // list: [ "eleven", "eleven", "eleven" ]

    qFill(list.begin() + 1, list.end(), "six");
    // list: [ "eleven", "six", "six" ]

See also qCopy() and forward iterators.

InputIterator qFind ( InputIterator begin, InputIterator end, const T & value )

Returns an iterator to the first occurrence of value in a container in the range [begin, end). Returns end if value isn't found.

Example:

    QList<QString> list;
    list << "one" << "two" << "three";

    QList<QString>::Iterator i1 = qFind(list.begin(), list.end(),
                                        "two");
    // i1 == list.begin() + 1

    QList<QString>::Iterator i2 = qFind(list.begin(), list.end(),
                                        "seventy");
    // i2 == list.end()

This function requires the item type (in the example above, QString) to implement operator==().

If the items in the range are in ascending order, you can get faster results by using qLowerBound() or qBinaryFind() instead of qFind().

See also qBinaryFind() and input iterators.

RandomAccessIterator qLowerBound ( RandomAccessIterator begin, RandomAccessIterator end, const T & value )

Performs a binary search of the range [begin, end) and returns the position of the first ocurrence of value. If no such item is found, returns the position where it should be inserted.

The items in the range [begin, end) must be sorted in ascending order; see qSort().

Example:

    QList<int> list;
    list << 3 << 3 << 6 << 6 << 6 << 8;

    QList<int>::Iterator i = qLowerBound(list.begin(), list.end(), 5);
    list.insert(i, 5);
    // list: [ 3, 3, 5, 6, 6, 6, 8 ]

    i = qLowerBound(list.begin(), list.end(), 12);
    list.insert(i, 12);
    // list: [ 3, 3, 5, 6, 6, 6, 8, 12 ]

This function requires the item type (in the example above, int) to implement operator<().

qLowerBound() can be used in conjunction with qUpperBound() to iterate over all occurrences of the same value:

    QVector<int> vect;
    vect << 3 << 3 << 6 << 6 << 6 << 8;
    QVector<int>::Iterator begin6 =
            qLowerBound(vect.begin(), vect.end(), 6);
    QVector<int>::Iterator end6 =
            qUpperBound(begin6, vect.end(), 6);

    QVector<int>::Iterator i = begin6;
    while (i != end6) {
        *i = 7;
        ++i;
    }
    // vect: [ 3, 3, 7, 7, 7, 8 ]

See also qUpperBound() and qBinaryFind().

void qSort ( BiIterator begin, BiIterator end )

Sorts the items in range [begin, end) in ascending order using the heap sort algorithm.

Example:

    QList<int> list;
    list << 33 << 12 << 68 << 6 << 12;
    qSort(list.begin(), list.end());
    // list: [ 6, 12, 12, 33, 68 ]

The sort algorithm is efficient on large data sets. It operates in linear-logarithmic time, O(n log n).

This function requires the item type (in the example above, int) to implement operator<().

If of two items neither is less than the other, the items are taken to be equal. It is then undefined which one of the two items will appear before the other after the sort.

See also qStableSort() and bidirectional iterators.

void qSort ( BiIterator begin, BiIterator end, LessThan lessThan )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Uses the lessThan function instead of operator<() to compare the items.

For example, here's how to sort the strings in a QList<QString> in case-insensitive alphabetical order:

    bool caseInsensitiveLessThan(const QString &s1, const QString &s2)
    {
        return s1.toLower() < s2.toLower();
    }

    int doSomething()
    {
        QList<QString> list;
        list << "AlPha" << "beTA" << "gamma" << "DELTA";
        qSort(list.begin(), list.end(), caseInsensitiveLessThan);
        // list: [ "AlPha", "beTA", "DELTA", "gamma" ]
    }

To sort values in reverse order, pass qGreater<T>() as the lessThan parameter. For example:

    QList<int> list;
    list << 33 << 12 << 68 << 6 << 12;
    qSort(list.begin(), list.end(), qGreater<int>());
    // list: [ 68, 33, 12, 12, 6 ]

If of two items neither is "less than" the other, the items are taken to be equal. It is then undefined which one of the two items will appear before the other after the sort.

void qSort ( Container & container )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

This is the same as qSort(container.begin(), container.end());

void qStableSort ( BiIterator begin, BiIterator end )

Sorts the items in range [begin, end) in ascending order using the heap sort algorithm.

Example:

    QList<int> list;
    list << 33 << 12 << 68 << 6 << 12;
    qStableSort(list.begin(), list.end());
    // list: [ 6, 12, 12, 33, 68 ]

The sort algorithm is efficient on large data sets. It operates in linear-logarithmic time, O(n log n).

This function requires the item type (in the example above, int) to implement operator<().

If of two items neither is less than the other, the items are taken to be equal. The item that appeared before the other in the original container will still appear first after the sort. This property is often useful when sorting user-visible data.

See also qSort() and bidirectional iterators.

void qStableSort ( BiIterator begin, BiIterator end, LessThan lessThan )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Uses the lessThan function instead of operator<() to compare the items.

For example, here's how to sort the strings in a QList<QString> in case-insensitive alphabetical order:

    bool caseInsensitiveLessThan(const QString &s1, const QString &s2)
    {
        return s1.toLower() < s2.toLower();
    }

    int doSomething()
    {
        QList<QString> list;
        list << "AlPha" << "beTA" << "gamma" << "DELTA";
        qStableSort(list.begin(), list.end(), caseInsensitiveLessThan);
        // list: [ "AlPha", "beTA", "DELTA", "gamma" ]
    }

To sort values in reverse order, pass qGreater<T>() as the lessThan parameter. For example:

    QList<int> list;
    list << 33 << 12 << 68 << 6 << 12;
    qStableSort(list.begin(), list.end(), qGreater<int>());
    // list: [ 68, 33, 12, 12, 6 ]

If of two items neither is "less than" the other, the items are taken to be equal. The item that appeared before the other in the original container will still appear first after the sort. This property is often useful when sorting user-visible data.

void qStableSort ( Container & container )

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

This is the same as qStableSort(container.begin(), container.end());

void qSwap ( T & var1, T & var2 )

Exchanges the values of variables var1 and var2.

Example:

    double pi = 3.14;
    double e = 2.71;

    qSwap(pi, e);
    // pi == 2.71, e == 3.14

RandomAccessIterator qUpperBound ( RandomAccessIterator begin, RandomAccessIterator end, const T & value )

Performs a binary search of the range [begin, end) and returns the position of the one-past-the-last occurrence of value. If no such item is found, returns the position where the item should be inserted.

The items in the range [begin, end) must be sorted in ascending order; see qSort().

Example:

    QList<int> list;
    list << 3 << 3 << 6 << 6 << 6 << 8;

    QList<int>::Iterator i = qUpperBound(list.begin(), list.end(), 5);
    list.insert(i, 5);
    // list: [ 3, 3, 5, 6, 6, 6, 8 ]

    i = qUpperBound(list.begin(), list.end(), 12);
    list.insert(i, 12);
    // list: [ 3, 3, 5, 6, 6, 6, 8, 12 ]

This function requires the item type (in the example above, int) to implement operator<().

qUpperBound() can be used in conjunction with qLowerBound() to iterate over all occurrences of the same value:

    QVector<int> vect;
    vect << 3 << 3 << 6 << 6 << 6 << 8;
    QVector<int>::Iterator begin6 =
            qLowerBound(vect.begin(), vect.end(), 6);
    QVector<int>::Iterator end6 =
            qUpperBound(vect.begin(), vect.end(), 6);

    QVector<int>::Iterator i = begin6;
    while (i != end6) {
        *i = 7;
        ++i;
    }
    // vect: [ 3, 3, 7, 7, 7, 8 ]

See also qLowerBound() and qBinaryFind().