Конкурентное фильтрация и фильтрация-сведение

Функции QtConcurrent::filter(), QtConcurrent::filtered() и QtConcurrent::filteredReduced() фильтруют элементы в последовательности, такой как QList или QVector, в параллельном режиме. QtConcurrent::filter() изменяет последовательность на месте, QtConcurrent::filtered() возвращает новую последовательность, содержащую отфильтрованные данные, а QtConcurrent::filteredReduced() возвращает единственный результат.

Эти функции являются частью фреймворка Qt Concurrent.

Каждая из вышеперечисленных функций имеет блокирующую версию, которая возвращает окончательный результат вместо QFuture. Вы используете их так же, как и асинхронные варианты.

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);

Обратите внимание, что типы результатов выше не являются объектами QFuture, а реальными типами результатов (в данном случае, QStringList и QSet<QString>).

Конкурентное фильтрация

QtConcurrent::filtered() принимает входную последовательность и функцию фильтрации. Затем эта функция фильтрации вызывается для каждого элемента в последовательности, и возвращается новая последовательность, содержащая отфильтрованные значения.

Функция фильтрации должна иметь вид:

bool function(const T &t);

T должен соответствовать типу, хранящемуся в последовательности. Функция возвращает true если элемент должен быть сохранён, false, если он должен быть отброшен.

Этот пример демонстрирует, как сохранить строки, которые содержат только строчные буквы из QStringList:

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

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

Результаты фильтрации доступны через QFuture. Обратитесь к документации по QFuture и QFutureWatcher для получения дополнительной информации о том, как использовать QFuture в ваших приложениях.

Если вы хотите изменить последовательность на месте, используйте QtConcurrent::filter():

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

Поскольку последовательность изменяется на месте, QtConcurrent::filter() не возвращает никаких результатов через QFuture. Однако вы по-прежнему можете использовать QFuture и QFutureWatcher для мониторинга статуса фильтрации.

Конкурентное фильтрация-сведение

QtConcurrent::filteredReduced() похожа на QtConcurrent::filtered(), но вместо возвращения последовательности с отфильтрованными результатами результаты объединяются в одно значение с помощью функции сведения.

Функция сведения должна иметь вид:

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

T — тип конечного результата, U — тип фильтруемых элементов. Обратите внимание, что возвращаемое значение и возвращаемый тип функции сведения не используются.

Вызовите QtConcurrent::filteredReduced() так:

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

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

Функция сведения будет вызываться один раз для каждого результата, сохраненного функцией фильтрации, и должна объединять промежуточное значение в переменную result. QtConcurrent::filteredReduced() гарантирует, что только одна нить будет вызывать функцию сведения за раз, поэтому использование мьютекса для блокировки переменной result не является необходимым. Перечисление QtConcurrent::ReduceOptions предоставляет способ управления порядком выполнения сведения.

Дополнительные возможности API

Использование итераторов вместо последовательности

Каждая из вышеперечисленных функций имеет вариант, принимающий диапазон итераторов вместо последовательности. Вы используете их так же, как и варианты для последовательностей:

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);

Использование методов-членов

QtConcurrent::filter(), QtConcurrent::filtered() и QtConcurrent::filteredReduced() принимают указатели на методы-члены. Тип класса метода-члена должен соответствовать типу, хранящемуся в последовательности:

// 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, &QChar::isPrint, &QSet<QChar>::insert);

Обратите внимание, что при использовании QtConcurrent::filteredReduced() вы можете свободно смешивать использование обычных функций и методов-членов:

// 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<int> > averageWordLength = QtConcurrent::filteredReduced(strings, allLowerCase, 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);

Использование объектов функций

QtConcurrent::filter(), QtConcurrent::filtered() и QtConcurrent::filteredReduced() принимают объекты функций, которые могут использоваться для добавления состояния к вызову функции. Тип результата typedef должен определять тип результата оператора вызова функции:

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

    typedef bool result_type;

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

    QString m_string;
};

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

Обертывание функций, принимающих несколько аргументов

Если вы хотите использовать функцию фильтрации, которая принимает более одного аргумента, вы можете использовать лямбда-функцию или std::bind() для её преобразования в функцию, принимающую один аргумент.

В качестве примера мы используем QString::contains():

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

QString::contains() принимает 2 аргумента (включая указатель «this») и не может использоваться с QtConcurrent::filtered() напрямую, потому что QtConcurrent::filtered() ожидает функцию, принимающую один аргумент. Чтобы использовать QString::contains() с QtConcurrent::filtered(), мы должны предоставить значение для аргумента regexp:

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