Concurrent Filter and Filter-Reduce | Qt Concurrent 6.8.3
Description: Selecting values from a sequence and combining them, all in parallel.

- Qt 6.8
- Qt Concurrent
- Concurrent Filter and Filter-Reduce
- Qt 6.8.3 Reference Documentation

# Concurrent Filter and Filter-Reduce

The QtConcurrent::filter(), QtConcurrent::filtered() and QtConcurrent::filteredReduced() functions filter items in a sequence such as a QList in parallel. QtConcurrent::filter() modifies a sequence in-place, QtConcurrent::filtered() returns a new sequence containing the filtered content, and QtConcurrent::filteredReduced() returns a single result.

These functions are part of the Qt Concurrent framework.

Each of the above functions have a blocking variant that returns the final result instead of a QFuture. You use them in the same way as the asynchronous variants.

     QStringList strings = ...;

     // each call blocks until the entire operation is finished
     QStringList lowerCaseStrings = QtConcurrent::blockingFiltered(strings, allLowerCase);

     QtConcurrent::blockingFilter(strings, allLowerCase);

     QSet<QString> dictionary = QtConcurrent::blockingFilteredReduced(strings, allLowerCase, addToDictionary);

Note that the result types above are not QFuture objects, but real result types (in this case, QStringList and QSet<QString>).

## Concurrent Filter

QtConcurrent::filtered() takes an input sequence and a filter function. This filter function is then called for each item in the sequence, and a new sequence containing the filtered values is returned.

The filter function must be of the form:

     bool function(const T &t);

T must match the type stored in the sequence. The function returns `true` if the item should be kept, false if it should be discarded.

This example shows how to keep strings that are all lower-case from a QStringList:

     bool allLowerCase(const QString &string)
     {
         return string.lowered() == string;
     }

     QStringList strings = ...;
     QFuture<QString> lowerCaseStrings = QtConcurrent::filtered(strings, allLowerCase);

The results of the filter are made available through QFuture. See the QFuture and QFutureWatcher documentation for more information on how to use QFuture in your applications.

If you want to modify a sequence in-place, use QtConcurrent::filter():

     QStringList strings = ...;
     QFuture<void> future = QtConcurrent::filter(strings, allLowerCase);

Since the sequence is modified in place, QtConcurrent::filter() does not return any results via QFuture. However, you can still use QFuture and QFutureWatcher to monitor the status of the filter.

## Concurrent Filter-Reduce

QtConcurrent::filteredReduced() is similar to QtConcurrent::filtered(), but instead of returning a sequence with the filtered results, the results are combined into a single value using a reduce function.

The reduce function must be of the form:

     V function(T &result, const U &intermediate)

T is the type of the final result, U is the type of items being filtered. Note that the return value and return type of the reduce function are not used.

Call QtConcurrent::filteredReduced() like this:

     void addToDictionary(QSet<QString> &dictionary, const QString &string)
     {
         dictionary.insert(string);
     }

     QStringList strings = ...;
     QFuture<QSet<QString>> dictionary = QtConcurrent::filteredReduced(strings, allLowerCase, addToDictionary);

The reduce function will be called once for each result kept by the filter function, and should merge the intermediate into the result variable. QtConcurrent::filteredReduced() guarantees that only one thread will call reduce at a time, so using a mutex to lock the result variable is not necessary. The QtConcurrent::ReduceOptions enum provides a way to control the order in which the reduction is done.

## Additional API Features

### Using Iterators instead of Sequence

Each of the above functions has a variant that takes an iterator range instead of a sequence. You use them in the same way as the sequence variants:

     QStringList strings = ...;
     QFuture<QString> lowerCaseStrings = QtConcurrent::filtered(strings.constBegin(), strings.constEnd(), allLowerCase);

     // filter in-place only works on non-const iterators
     QFuture<void> future = QtConcurrent::filter(strings.begin(), strings.end(), allLowerCase);

     QFuture<QSet<QString>> dictionary = QtConcurrent::filteredReduced(strings.constBegin(), strings.constEnd(), allLowerCase, addToDictionary);

### Using Member Functions

QtConcurrent::filter(), QtConcurrent::filtered(), and QtConcurrent::filteredReduced() accept pointers to member functions. The member function class type must match the type stored in the sequence:

     // keep only images with an alpha channel
     QList<QImage> images = ...;
     QFuture<void> alphaImages = QtConcurrent::filter(images, &QImage::hasAlphaChannel);

     // retrieve gray scale images
     QList<QImage> images = ...;
     QFuture<QImage> grayscaleImages = QtConcurrent::filtered(images, &QImage::isGrayscale);

     // create a set of all printable characters
     QList<QChar> characters = ...;
     QFuture<QSet<QChar>> set = QtConcurrent::filteredReduced(characters, qOverload<>(&QChar::isPrint),
                                                              qOverload<const QChar&>(&QSet<QChar>::insert));

Note the use of qOverload. It is needed to resolve the ambiguity for the methods, that have multiple overloads.

Also note that when using QtConcurrent::filteredReduced(), you can mix the use of normal and member functions freely:

     // can mix normal functions and member functions with QtConcurrent::filteredReduced()

     // create a dictionary of all lower cased strings
     extern bool allLowerCase(const QString &string);
     QStringList strings = ...;
     QFuture<QSet<QString>> lowerCase = QtConcurrent::filteredReduced(strings, allLowerCase,
                                                                      qOverload<const QString&>(&QSet<QString>::insert));

     // create a collage of all gray scale images
     extern void addToCollage(QImage &collage, const QImage &grayscaleImage);
     QList<QImage> images = ...;
     QFuture<QImage> collage = QtConcurrent::filteredReduced(images, &QImage::isGrayscale, addToCollage);

### Using Function Objects

QtConcurrent::filter(), QtConcurrent::filtered(), and QtConcurrent::filteredReduced() accept function objects for the filter function. These function objects can be used to add state to a function call:

     struct StartsWith
     {
         StartsWith(const QString &string)
         : m_string(string) { }

         bool operator()(const QString &testString)
         {
             return testString.startsWith(m_string);
         }

         QString m_string;
     };

     QList<QString> strings = ...;
     QFuture<QString> fooString = QtConcurrent::filtered(strings, StartsWith(QLatin1String("Foo")));

Function objects are also supported for the reduce function:

     struct StringTransform
     {
         void operator()(QString &result, const QString &value);
     };

     QFuture<QString> fooString =
             QtConcurrent::filteredReduced(strings, StartsWith(QLatin1String("Foo")), StringTransform());

### Using Lambda Expressions

QtConcurrent::filter(), QtConcurrent::filtered(), and QtConcurrent::filteredReduced() accept lambda expressions for the filter and reduce function:

     // keep only even integers
     QList<int> list { 1, 2, 3, 4 };
     QtConcurrent::blockingFilter(list, [](int n) { return (n & 1) == 0; });

     // retrieve only even integers
     QList<int> list2 { 1, 2, 3, 4 };
     QFuture<int> future = QtConcurrent::filtered(list2, [](int x) {
         return (x & 1) == 0;
     });
     QList<int> results = future.results();

     // add up all even integers
     QList<int> list3 { 1, 2, 3, 4 };
     QFuture<int> sum = QtConcurrent::filteredReduced(list3,
         [](int x) {
             return (x & 1) == 0;
         },
         [](int &sum, int x) {
             sum += x;
         }
     );

When using QtConcurrent::filteredReduced() or QtConcurrent::blockingFilteredReduced(), you can mix the use of normal functions, member functions and lambda expressions freely.

     void intSumReduce(int &sum, int x)
     {
         sum += x;
     }

     QList<int> list { 1, 2, 3, 4 };
     QFuture<int> sum = QtConcurrent::filteredReduced(list,
         [] (int x) {
             return (x & 1) == 0;
         },
         intSumReduce
     );

You can also pass a lambda as a reduce object:

     bool keepEvenIntegers(int x)
     {
         return (x & 1) == 0;
     }

     QList<int> list { 1, 2, 3, 4 };
     QFuture<int> sum = QtConcurrent::filteredReduced(list,
         keepEvenIntegers,
         [](int &sum, int x) {
             sum += x;
         }
     );

### Wrapping Functions that Take Multiple Arguments

If you want to use a filter function takes more than one argument, you can use a lambda function or `std::bind()` to transform it onto a function that takes one argument.

As an example, we use QString::contains():

     bool QString::contains(const QRegularExpression &regexp) const;

QString::contains() takes 2 arguments (including the "this" pointer) and can't be used with QtConcurrent::filtered() directly, because QtConcurrent::filtered() expects a function that takes one argument. To use QString::contains() with QtConcurrent::filtered() we have to provide a value for the regexp argument:

     QStringList strings = ...;
     QFuture<QString> future = QtConcurrent::filtered(list, [](const QString &str) {
         return str.contains(QRegularExpression("^\\S+$")); // matches strings without whitespace
     });