Namespaces
Variants

std::ranges:: fold_left_first

From cppreference.net
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy , ranges::sort , ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
(C++17)
Search operations
Modifying sequence operations
Copy operations
(C++11)
(C++11)
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17) (C++11)
(C++20) (C++20)
Sampling operations
(C++17)

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Lexicographical comparison operations
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
Constrained algorithms
All names in this menu belong to namespace std::ranges
Non-modifying sequence operations
Modifying sequence operations
Partitioning operations
Sorting operations
Binary search operations (on sorted ranges)
Set operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Permutation operations
Fold operations
(C++23)
fold_left_first
(C++23)
Operations on uninitialized storage
Return types
Определено в заголовочном файле <algorithm>
Сигнатура вызова
template < std:: input_iterator I, std:: sentinel_for < I > S,

/*indirectly-binary-left-foldable*/ < std:: iter_value_t < I > , I > F >
requires std:: constructible_from < std:: iter_value_t < I > , std:: iter_reference_t < I >>
constexpr auto

fold_left_first ( I first, S last, F f ) ;
(1) (начиная с C++23)
template < ranges:: input_range R,

/*indirectly-binary-left-foldable*/ <
ranges:: range_value_t < R > , ranges:: iterator_t < R >> F >
requires std:: constructible_from <
ranges:: range_value_t < R > , ranges:: range_reference_t < R >>
constexpr auto

fold_left_first ( R && r, F f ) ;
(2) (начиная с C++23)
Вспомогательные концепты
template < class F, class T, class I >
concept /*indirectly-binary-left-foldable*/ = /* см. описание */ ;
(3) ( только для демонстрации* )

Сворачивает элементы заданного диапазона слева, то есть возвращает результат вычисления цепочки выражений:
f(f(f(f(x 1 , x 2 ), x 3 ), ...), x n ) , где x 1 , x 2 , ..., x n являются элементами диапазона.

Неформально говоря, ranges::fold_left_first ведёт себя подобно перегрузке std::accumulate , принимающей бинарный предикат, за исключением того, что * first используется внутри как начальный элемент.

Поведение не определено, если [ first , last ) не является допустимым диапазоном.

1) Диапазон - [ first , last ) . Эквивалентно return ranges:: fold_left_first_with_iter ( std :: move ( first ) , last, f ) . value .
2) То же, что и (1) , за исключением того, что использует r в качестве диапазона, как если бы использовались ranges:: begin ( r ) в качестве first и ranges:: end ( r ) в качестве last .
3) Эквивалентно:
Вспомогательные концепты
template < class F, class T, class I, class U >

concept /*indirectly-binary-left-foldable-impl*/ =
std:: movable < T > &&
std:: movable < U > &&
std:: convertible_to < T, U > &&
std:: invocable < F & , U, std:: iter_reference_t < I >> &&
std:: assignable_from < U & ,

std:: invoke_result_t < F & , U, std:: iter_reference_t < I >>> ;
(3A) ( только для демонстрации* )
template < class F, class T, class I >

concept /*indirectly-binary-left-foldable*/ =
std:: copy_constructible < F > &&
std:: indirectly_readable < I > &&
std:: invocable < F & , T, std:: iter_reference_t < I >> &&
std:: convertible_to < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >> ,
std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>>> &&
/*indirectly-binary-left-foldable-impl*/ < F, T, I,

std:: decay_t < std:: invoke_result_t < F & , T, std:: iter_reference_t < I >>>> ;
(3B) ( только для демонстрации* )

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

Содержание

Параметры

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

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

Объект типа std:: optional < U > , содержащий результат левосторонней свертки заданного диапазона с помощью f , где U эквивалентен decltype ( ranges:: fold_left ( std :: move ( first ) , last, std:: iter_value_t < I > ( * first ) , f ) ) .

Если диапазон пуст, std:: optional < U > ( ) возвращается.

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

struct fold_left_first_fn
{
    template<std::input_iterator I, std::sentinel_for<I> S,
             /*indirectly-binary-left-foldable*/<std::iter_value_t<I>, I> F>
    requires
        std::constructible_from<std::iter_value_t<I>, std::iter_reference_t<I>>
    constexpr auto operator()(I first, S last, F f) const
    {
        using U = decltype(
            ranges::fold_left(std::move(first), last, std::iter_value_t<I>(*first), f)
        );
        if (first == last)
            return std::optional<U>();
        std::optional<U> init(std::in_place, *first);
        for (++first; first != last; ++first)
            *init = std::invoke(f, std::move(*init), *first);
        return std::move(init);
    }
    template<ranges::input_range R,
             /*indirectly-binary-left-foldable*/<
                 ranges::range_value_t<R>, ranges::iterator_t<R>> F>
    requires
        std::constructible_from<ranges::range_value_t<R>, ranges::range_reference_t<R>>
    constexpr auto operator()(R&& r, F f) const
    {
        return (*this)(ranges::begin(r), ranges::end(r), std::ref(f));
    }
};
inline constexpr fold_left_first_fn fold_left_first;

Сложность

Ровно ranges:: distance ( first, last ) - 1 (при условии, что диапазон не пуст) применений функционального объекта f .

Примечания

В следующей таблице представлено сравнение всех алгоритмов ограниченного фолдинга:

Шаблон функции свертки Начинается с Начальное значение Тип возвращаемого значения
ranges:: fold_left слева init U
ranges :: fold_left_first слева первого элемента std:: optional < U >
ranges:: fold_right справа init U
ranges:: fold_right_last справа последнего элемента std:: optional < U >
ranges:: fold_left_with_iter слева init

(1) ranges:: in_value_result < I, U >

(2) ranges:: in_value_result < BR, U > ,

где BR это ranges:: borrowed_iterator_t < R >

ranges:: fold_left_first_with_iter слева первого элемента

(1) ranges:: in_value_result < I, std:: optional < U >>

(2) ranges:: in_value_result < BR, std:: optional < U >>

где BR это ranges:: borrowed_iterator_t < R >

Макрос тестирования возможностей Значение Стандарт Функция
__cpp_lib_ranges_fold 202207L (C++23) std::ranges алгоритмы свёртки

Пример

#include <algorithm>
#include <array>
#include <functional>
#include <ranges>
#include <utility>
int main()
{
    constexpr std::array v{1, 2, 3, 4, 5, 6, 7, 8};
    static_assert
    (
        *std::ranges::fold_left_first(v.begin(), v.end(), std::plus{}) == 36
        && *std::ranges::fold_left_first(v, std::multiplies{}) == 40320
    );
    constexpr std::array w
    {
        1, 2, 3, 4, 13,
        1, 2, 3, 4, 13,
        1, 2, 3, 4, 13,
        1, 2, 3, 4,
    };
    static_assert
    (
        "Найти единственное значение, которое (по предварительному условию) встречается нечетное количество раз:"
        && *std::ranges::fold_left_first(w, [](int p, int q){ return p ^ q; }) == 13
    );
    constexpr auto pairs = std::to_array<std::pair<char, float>>
    ({
        {'A', 3.0f},
        {'B', 3.5f},
        {'C', 4.0f}
    });
    static_assert
    (
        "Получить произведение всех pair::second в парах:"
        && *std::ranges::fold_left_first
        (
            pairs | std::ranges::views::values, std::multiplies{}
        ) == 42
    );
}

Ссылки

  • Стандарт C++23 (ISO/IEC 14882:2024):
  • 27.6.18 Свёртка [alg.fold]

Смотрите также

левостороннее свертывание диапазона элементов
(функциональный объект алгоритма)
правостороннее свертывание диапазона элементов
(функциональный объект алгоритма)
правостороннее свертывание диапазона элементов с использованием последнего элемента в качестве начального значения
(функциональный объект алгоритма)
левостороннее свертывание диапазона элементов и возврат пары (итератор, значение)
(функциональный объект алгоритма)
левостороннее свертывание диапазона элементов с использованием первого элемента в качестве начального значения и возврат пары (итератор, optional )
(функциональный объект алгоритма)
суммирует или сворачивает диапазон элементов
(шаблон функции)
(C++17)
аналогично std::accumulate , но без сохранения порядка
(шаблон функции)