Constrained algorithms and algorithms on ranges(C++20) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Constrained algorithms, e.g.ranges::copy,ranges::sort, ... | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Execution policies(C++17) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Numeric operations | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operations on uninitialized memory | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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 | |||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||
Operations on uninitialized storage | |||||||||||||||||||||||||||||||||
Return types | |||||||||||||||||||||||||||||||||
Defined in header <algorithm> | ||
Call signature | ||
template<std::input_iterator I,std::sentinel_for<I> S, /*indirectly-binary-left-foldable*/<std::iter_value_t<I>, I> F> | (1) | (since C++23) |
template<ranges::input_range R, /*indirectly-binary-left-foldable*/< | (2) | (since C++23) |
Helper concepts | ||
template<class F,class T,class I> concept/*indirectly-binary-left-foldable*/=/* see description */; | (3) | (exposition only*) |
Left-folds the elements of given range, that is, returns the result of evaluation of the chain expression:f(f(f(f(x1, x2), x3), ...), xn)
, wherex1
,x2
, ...,xn
are elements of the range.
Informally,ranges::fold_left_first
behaves likestd::accumulate's overload that accepts a binary predicate, except that the*first is used internally as an initial element.
The behavior is undefined if[
first,
last)
is not a valid range.
[
first,
last)
. Equivalent toreturnranges::fold_left_first_with_iter(std::move(first), last, f).value.Helper concepts | ||
template<class F,class T,class I,class U> concept/*indirectly-binary-left-foldable-impl*/= | (3A) | (exposition only*) |
template<class F,class T,class I> concept/*indirectly-binary-left-foldable*/= | (3B) | (exposition only*) |
The function-like entities described on this page arealgorithm function objects (informally known asniebloids), that is:
Contents |
first, last | - | the iterator-sentinel pair defining therange of elements to fold |
r | - | the range of elements to fold |
f | - | the binary function object |
An object of typestd::optional<U> that contains the result of left-fold of the given range overf, whereU is equivalent todecltype(ranges::fold_left(std::move(first), last,std::iter_value_t<I>(*first), f)).
If the range is empty,std::optional<U>() is returned.
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> requiresstd::constructible_from<std::iter_value_t<I>,std::iter_reference_t<I>>constexprauto 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)returnstd::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> requiresstd::constructible_from<ranges::range_value_t<R>,ranges::range_reference_t<R>>constexprauto operator()(R&& r, F f)const{return(*this)(ranges::begin(r),ranges::end(r),std::ref(f));}}; inlineconstexpr fold_left_first_fn fold_left_first; |
Exactlyranges::distance(first, last)-1 (assuming the range is not empty) applications of the function objectf.
The following table compares all constrained folding algorithms:
Fold function template | Starts from | Initial value | Return type |
---|---|---|---|
ranges::fold_left | left | init | U |
ranges::fold_left_first | left | first element | std::optional<U> |
ranges::fold_right | right | init | U |
ranges::fold_right_last | right | last element | std::optional<U> |
ranges::fold_left_with_iter | left | init | (1)ranges::in_value_result<I, U> (2)ranges::in_value_result<BR, U>, whereBR isranges::borrowed_iterator_t<R> |
ranges::fold_left_first_with_iter | left | first element | (1)ranges::in_value_result<I,std::optional<U>> (2)ranges::in_value_result<BR,std::optional<U>> whereBR isranges::borrowed_iterator_t<R> |
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_ranges_fold | 202207L | (C++23) | std::ranges fold algorithms |
#include <algorithm>#include <array>#include <functional>#include <ranges>#include <utility> int main(){constexprstd::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); constexprstd::array w{1,2,3,4,13,1,2,3,4,13,1,2,3,4,13,1,2,3,4,}; static_assert("Find the only value that (by precondition) occurs odd number of times:"&&*std::ranges::fold_left_first(w,[](int p,int q){return p^ q;})==13); constexprauto pairs=std::to_array<std::pair<char,float>>({{'A',3.0f},{'B',3.5f},{'C',4.0f}}); static_assert("Get the product of all pair::second in pairs:"&&*std::ranges::fold_left_first( pairs| std::ranges::views::values,std::multiplies{})==42);}
(C++23) | left-folds a range of elements (algorithm function object)[edit] |
(C++23) | right-folds a range of elements (algorithm function object)[edit] |
(C++23) | right-folds a range of elements using the last element as an initial value (algorithm function object)[edit] |
(C++23) | left-folds a range of elements, and returns apair (iterator, value) (algorithm function object)[edit] |
left-folds a range of elements using the first element as an initial value, and returns apair (iterator,optional) (algorithm function object)[edit] | |
sums up or folds a range of elements (function template)[edit] | |
(C++17) | similar tostd::accumulate, except out of order (function template)[edit] |