std::ranges::for_each, std::ranges::for_each_result

Определено в заголовке `<algorithm>`
Сигнатура вызова
template< std::input_iterator I, std::sentinel_for<I> S, class Proj = std::identity, std::indirectly_unary_invocable<std::projected<I, Proj>> Fun > constexpr for_each_result<I, Fun> for_each( I first, S last, Fun f, Proj proj = {} );	(1)	(начиная с C++20)
template< ranges::input_range R, class Proj = std::identity, std::indirectly_unary_invocable <std::projected<ranges::iterator_t<R>, Proj>> Fun > constexpr for_each_result<ranges::borrowed_iterator_t<R>, Fun> for_each( R&& r, Fun f, Proj proj = {} );	(2)	(начиная с C++20)
template< /execution-policy/ Ep, std::random_access_iterator I, std::sized_sentinel_for<I> S, class Proj = std::identity, std::indirectly_unary_invocable<std::projected<I, Proj>> Fun > I for_each( Ep&& policy, I first, S last, Fun f, Proj proj = {} );	(3)	(начиная с C++26)
template< /execution-policy/ Ep, /sized-random-access-range/ R, class Proj = std::identity, std::indirectly_unary_invocable <std::projected<ranges::iterator_t<R>, Proj>> Fun > ranges::borrowed_iterator_t<R> for_each( Ep&& policy, R&& r, Fun f, Proj proj = {} );	(4)	(начиная с C++26)
Вспомогательные типы
template< class I, class F > using for_each_result = ranges::in_fun_result<I, F>;	(5)	(начиная с C++20)

Для определения /*execution-policy*/, см. эту страницу; для определения /*sized-random-access-range*/, см. эту страницу.

Применяет заданный вызываемый объект f к каждому элементу (спроецированному с помощью proj) в целевом диапазоне [first, last) или r. Если f возвращает результат, он игнорируется.

1,2) f применяется по порядку от начала целевого диапазона.

3,4) f может применяться не по порядку. Алгоритм выполняется в соответствии с policy.

В отличие от других параллельных алгоритмов, for_each не допускается создавать произвольные копии элементов из целевого диапазона.

Функциональные объекты, описанные на этой странице, являются объектами-функциями алгоритмов (неформально известными как niebloids), то есть:

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

Параметры

first, last	-	пара итераторов, определяющая целевой диапазон
r	-	целевой диапазон
f	-	вызываемый объект, применяемый к (проецируемым) элементам
proj	-	проекция, применяемая к элементам
policy	-	используемая политика выполнения для использования

Возвращаемое значение

1) {last, std::move(f)}

2) {ranges::next(ranges::begin(r), ranges::end(r)), std::move(f)} если R моделирует forward_range, иначе (начиная с C++26){ranges::end(r), std::move(f)}

3) last

4) ranges::next(ranges::begin(r), ranges::end(r)) если R моделирует forward_range, иначе (начиная с C++26)ranges::end(r)

Сложность

1,3) Ровно ranges::distance(first, last) применений f и proj.

2,4) Ровно ranges::distance(r) применений f и proj.

Исключения

3,4) Во время процесса выполнения:

Если временные ресурсы памяти, необходимые для распараллеливания, недоступны, std::bad_alloc выбрасывается.
Если необработанное исключение выбрасывается при доступе к объектам через аргумент алгоритма, поведение определяется политикой выполнения (для стандартных политик, std::terminate вызывается).

Примечания

Если проекция возвращает изменяемую ссылку, f может изменять элементы в целевом диапазоне.

Для перегрузок (1,2) f может быть вызываемым объектом с состоянием. Вызываемый объект в возвращаемом значении можно рассматривать как конечное состояние пакетной операции.

Для перегрузок (3,4) может быть создано несколько копий f для выполнения параллельного вызова. Возвращаемое значение не содержит вызываемого объекта, поскольку параллелизация часто не допускает эффективного накопления состояния.

Возможная реализация

struct for_each_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S, class Proj = std::identity,
             std::indirectly_unary_invocable<std::projected<I, Proj>> Fun>
    constexpr ranges::for_each_result<I, Fun>
        operator()(I first, S last, Fun f, Proj proj = {}) const
    {
        for (; first != last; ++first)
            std::invoke(f, std::invoke(proj, *first));
        return {std::move(first), std::move(f)};
    }
    
    template<ranges::input_range R, class Proj = std::identity,
             std::indirectly_unary_invocable
                 <std::projected<ranges::iterator_t<R>, Proj>> Fun>
    constexpr ranges::for_each_result<ranges::borrowed_iterator_t<R>, Fun>
        operator()(R&& r, Fun f, Proj proj = {}) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), std::move(f), std::ref(proj));
    }
    
    template<ranges::forward_range R, class Proj = std::identity,
             std::indirectly_unary_invocable
                 <std::projected<ranges::iterator_t<R>, Proj>> Fun>
    constexpr ranges::for_each_result<ranges::borrowed_iterator_t<R>, Fun>
        operator()(R&& r, Fun f, Proj proj = {}) const
    {
        return (*this)(ranges::begin(r),
                       ranges::next(ranges::begin(r), ranges::end(r)),
                       std::move(f), std::ref(proj));
    }
};

inline constexpr for_each_fn for_each;

Пример

В следующем примере используется лямбда-выражение для инкремента всех элементов вектора, а затем используется перегруженный operator() в вызываемом объекте для вычисления их суммы. Обратите внимание, что для вычисления суммы рекомендуется использовать специальный алгоритм std::accumulate.

Запустить этот код

#include <algorithm>
#include <cassert>
#include <iostream>
#include <string>
#include <utility>
#include <vector>

struct Sum
{
    void operator()(int n) { sum += n; }
    int sum {0};
};

int main()
{
    namespace ranges = std::ranges;
    
    std::vector<int> nums {3, 4, 2, 8, 15, 267};
    
    auto print = [](const auto& n) { std::cout << ' ' << n; };
    
    std::cout << "before:";
    ranges::for_each(std::as_const(nums), print);
    print('\n');
    
    ranges::for_each(nums, [](int& n) { ++n; });
    
    // calls Sum::operator() for each number
    auto [i, s] = ranges::for_each(nums.begin(), nums.end(), Sum());
    assert(i == nums.end());
    
    std::cout << "after: ";
    ranges::for_each(nums.cbegin(), nums.cend(), print);
    
    std::cout << "\n" "sum: " << s.sum << '\n';
    
    using pair = std::pair<int, std::string>; 
    std::vector<pair> pairs {{1,"one"}, {2,"two"}, {3,"tree"}};
    
    std::cout << "project the pair::first: ";
    ranges::for_each(pairs, print, [](const pair& p) { return p.first; });
    
    std::cout << "\n" "project the pair::second:";
    ranges::for_each(pairs, print, &pair::second);
    print('\n');
}

Вывод:

before: 3 4 2 8 15 267 
after:  4 5 3 9 16 268
sum: 305
project the pair::first:  1 2 3
project the pair::second: one two tree

См. также

for_each	применяет унарный функциональный объект к элементам из диапазона (шаблон функции)
ranges::for_each_n (C++20)	применяет функциональный объект к первым N элементам последовательности (алгоритмический функциональный объект)
ranges::transform (C++20)	применяет функцию к диапазону элементов (алгоритмический функциональный объект)
диапазон-`for` цикл(C++11)	выполняет цикл по диапазону

Поддержка компиляторов
Автономные и размещённые
Язык
Стандартная библиотека
Заголовочные файлы стандартной библиотеки
Именованные требования
Макросы проверки возможностей (C++20)
Библиотека поддержки языка
Библиотека концептов (C++20)
Библиотека диагностики
Библиотека управления памятью
Библиотека метапрограммирования (C++11)
Библиотека общих утилит
Библиотека контейнеров
Библиотека итераторов
Библиотека диапазонов (C++20)
Библиотека алгоритмов
Библиотека строк
Библиотека обработки текста
Библиотека численных операций
Библиотека даты и времени
Библиотека ввода-вывода
Библиотека файловой системы (C++17)
Библиотека поддержки параллелизма (C++11)
Библиотека управления выполнением (C++26)
Технические спецификации
Индекс символов
Внешние библиотеки

ru.cppreference.net

Namespaces

Variants