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 | ||
(1) | ||
template<std::input_iterator I,std::sentinel_for<I> S,class T, /* indirectly-binary-left-foldable */<T, I> F> | (since C++23) (until C++26) | |
template<std::input_iterator I,std::sentinel_for<I> S, class T=std::iter_value_t<I>, | (since C++26) | |
(2) | ||
template<ranges::input_range R,class T, /* indirectly-binary-left-foldable */ | (since C++23) (until C++26) | |
template<ranges::input_range R,class T=ranges::range_value_t<R>, /* indirectly-binary-left-foldable */ | (since C++26) | |
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(init, x1), x2), ...), xn)
, wherex1
,x2
, ...,xn
are elements of the range.
Informally,ranges::fold_left
behaves likestd::accumulate's overload that accepts a binary predicate.
The behavior is undefined if[
first,
last)
is not a valid range.
[
first,
last)
. Equivalent toreturnranges::fold_left_with_iter(std::move(first), last, std::move(init), 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 |
init | - | the initial value of the fold |
f | - | the binary function object |
An object of typeU that contains the result of left-fold of the given range overf, whereU is equivalent tostd::decay_t<std::invoke_result_t<F&, T,std::iter_reference_t<I>>>.
If the range is empty,U(std::move(init)) is returned.
struct fold_left_fn{template<std::input_iterator I,std::sentinel_for<I> S,class T=std::iter_value_t<I>,/* indirectly-binary-left-foldable */<T, I> F>constexprauto operator()(I first, S last, T init, F f)const{using U=std::decay_t<std::invoke_result_t<F&, T,std::iter_reference_t<I>>>;if(first== last)return U(std::move(init)); U accum=std::invoke(f, std::move(init),*first);for(++first; first!= last;++first) accum=std::invoke(f, std::move(accum),*first);return std::move(accum);} template<ranges::input_range R,class T=ranges::range_value_t<R>,/* indirectly-binary-left-foldable */<T,ranges::iterator_t<R>> F>constexprauto operator()(R&& r, T init, F f)const{return(*this)(ranges::begin(r),ranges::end(r), std::move(init),std::ref(f));}}; inlineconstexpr fold_left_fn fold_left; |
Exactlyranges::distance(first, last) 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 |
__cpp_lib_algorithm_default_value_type | 202403L | (C++26) | List-initialization for algorithms(1,2) |
#include <algorithm>#include <complex>#include <functional>#include <iostream>#include <ranges>#include <string>#include <utility>#include <vector> int main(){namespace ranges= std::ranges; std::vector v{1,2,3,4,5,6,7,8}; int sum= ranges::fold_left(v.begin(), v.end(),0,std::plus<int>());// (1)std::cout<<"sum: "<< sum<<'\n'; int mul= ranges::fold_left(v,1,std::multiplies<int>());// (2)std::cout<<"mul: "<< mul<<'\n'; // get the product of the std::pair::second of all pairs in the vector:std::vector<std::pair<char,float>> data{{'A',2.f},{'B',3.f},{'C',3.5f}};float sec= ranges::fold_left( data| ranges::views::values,2.0f,std::multiplies<>());std::cout<<"sec: "<< sec<<'\n'; // use a program defined function object (lambda-expression):std::string str= ranges::fold_left( v,"A",[](std::string s,int x){return s+':'+std::to_string(x);});std::cout<<"str: "<< str<<'\n'; using CD=std::complex<double>;std::vector<CD> nums{{1,1},{2,0},{3,0}};#ifdef __cpp_lib_algorithm_default_value_typeauto res= ranges::fold_left(nums,{7,0},std::multiplies{});// (2)#elseauto res= ranges::fold_left(nums, CD{7,0},std::multiplies{});// (2)#endifstd::cout<<"res: "<< res<<'\n';}
Output:
sum: 36mul: 40320sec: 42str: A:1:2:3:4:5:6:7:8res: (42,42)
(C++23) | left-folds a range of elements using the first element as an initial value (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] |