Difference between revisions of "cpp/algorithm/ranges/partition copy"
From cppreference.com
m (→Example: reducing the code size with ostream_iterator<char>) |
m (→Possible implementation: fmt) |
||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 2: | Line 2: | ||
{{cpp/algorithm/ranges/navbar}} | {{cpp/algorithm/ranges/navbar}} | ||
{{dcl begin}} | {{dcl begin}} | ||
| − | {{dcl header | algorithm}} | + | {{dcl header|algorithm}} |
| − | {{dcl h | Call signature}} | + | {{dcl h|Call signature}} |
| − | {{dcl | since=c++20 | num=1 |1= | + | {{dcl|since=c++20|num=1|1= |
| − | template <std::input_iterator I, std::sentinel_for<I> S, | + | template< std::input_iterator I, std::sentinel_for<I> S, |
| − | + | std::weakly_incrementable O1, std::weakly_incrementable O2, | |
| − | + | class Proj = std::identity, | |
| − | + | std::indirect_unary_predicate<std::projected<I, Proj>> Pred > | |
| − | requires std::indirectly_copyable<I, O1> && std::indirectly_copyable<I, O2> | + | requires std::indirectly_copyable<I, O1> && |
| − | constexpr | + | std::indirectly_copyable<I, O2> |
| − | + | constexpr partition_copy_result<I, O1, O2> | |
| + | partition_copy( I first, S last, O1 out_true, O2 out_false, | ||
| + | Pred pred, Proj proj = {} ); | ||
}} | }} | ||
| − | {{dcl | since=c++20 | num=2 |1= | + | {{dcl|since=c++20|num=2|1= |
| − | template<ranges::input_range R, std::weakly_incrementable O1, std::weakly_incrementable O2, | + | template< ranges::input_range R, |
| − | + | std::weakly_incrementable O1, std::weakly_incrementable O2, | |
| − | + | class Proj = std::identity, | |
| + | std::indirect_unary_predicate<std::projected<iterator_t<R>, Proj>> Pred > | ||
requires std::indirectly_copyable<ranges::iterator_t<R>, O1> && | requires std::indirectly_copyable<ranges::iterator_t<R>, O1> && | ||
std::indirectly_copyable<ranges::iterator_t<R>, O2> | std::indirectly_copyable<ranges::iterator_t<R>, O2> | ||
| − | constexpr | + | constexpr partition_copy_result<ranges::borrowed_iterator_t<R>, O1, O2> |
| − | + | partition_copy( R&& r, O1 out_true, O2 out_false, | |
| + | Pred pred, Proj proj = {} ); | ||
}} | }} | ||
| − | {{dcl h | Helper types}} | + | {{dcl h|Helper types}} |
| − | {{dcl | num=3 | since=c++20 |1= | + | {{dcl|num=3|since=c++20|1= |
| − | template<class I, class O1, class O2> | + | template< class I, class O1, class O2 > |
using partition_copy_result = ranges::in_out_out_result<I, O1, O2>; | using partition_copy_result = ranges::in_out_out_result<I, O1, O2>; | ||
}} | }} | ||
{{dcl end}} | {{dcl end}} | ||
| − | @1@ Copies the elements from the input range {{ | + | @1@ Copies the elements from the input range {{range|first|last}} to two different output ranges depending on the value returned by the predicate {{c|pred}}. The elements that satisfy the predicate {{c|pred}} after projection by {{c|proj}} are copied to the range beginning at {{c|out_true}}. The rest of the elements are copied to the range beginning at {{c|out_false}}. The behavior is undefined if the input range overlaps either of the output ranges. |
| − | + | @2@ Same as {{v|1}}, but uses {{c|r}} as the source range, as if using {{c|ranges::begin(r)}} as {{c|first}}, and {{c|ranges::end(r)}} as {{c|last}}. | |
| − | + | ||
| − | @2@ Same as {{v|1}}, but uses {{ | + | |
{{cpp/ranges/niebloid}} | {{cpp/ranges/niebloid}} | ||
| Line 39: | Line 41: | ||
===Parameters=== | ===Parameters=== | ||
{{par begin}} | {{par begin}} | ||
| − | {{par | first, last | the input range of elements to copy from}} | + | {{par|first, last|the input range of elements to copy from}} |
| − | {{par | r | the input range of elements to copy from}} | + | {{par|r|the input range of elements to copy from}} |
| − | {{par | out_true | the beginning of the output range for the elements that satisfy {{ | + | {{par|out_true|the beginning of the output range for the elements that satisfy {{c|pred}}}} |
| − | {{par | out_false | the beginning of the output range for the elements that do not satisfy {{ | + | {{par|out_false|the beginning of the output range for the elements that do not satisfy {{c|pred}}}} |
| − | {{par | pred | predicate to apply to the projected elements}} | + | {{par|pred|predicate to apply to the projected elements}} |
| − | {{par | proj | projection to apply to the elements | + | {{par|proj|projection to apply to the elements}} |
{{par end}} | {{par end}} | ||
===Return value=== | ===Return value=== | ||
| − | + | {{c|{last, o1, o2} }}, where {{tt|o1}} and {{tt|o2}} are the ends of the output ranges respectively, after the copying is complete. | |
===Complexity=== | ===Complexity=== | ||
| − | Exactly {{c|ranges::distance(first, last)}} applications of the corresponding predicate {{ | + | Exactly {{c|ranges::distance(first, last)}} applications of the corresponding predicate {{c|comp}} and any projection {{c|proj}}. |
<!-- ===Exceptions=== --> | <!-- ===Exceptions=== --> | ||
===Possible implementation=== | ===Possible implementation=== | ||
| − | {{eq fun | 1= | + | {{eq fun|1= |
| − | struct partition_copy_fn { | + | struct partition_copy_fn |
| − | + | { | |
| − | + | template<std::input_iterator I, std::sentinel_for<I> S, | |
| − | + | std::weakly_incrementable O1, std::weakly_incrementable O2, | |
| − | + | class Proj = std::identity, std::indirect_unary_predicate< | |
| − | + | std::projected<I, Proj>> Pred> | |
| − | + | requires std::indirectly_copyable<I, O1> && std::indirectly_copyable<I, O2> | |
| − | + | constexpr ranges::partition_copy_result<I, O1, O2> | |
| − | + | operator()(I first, S last, O1 out_true, O2 out_false, | |
| − | + | Pred pred, Proj proj = {}) const | |
| − | + | { | |
| − | + | for (; first != last; ++first) | |
| − | + | if (!!std::invoke(pred, std::invoke(proj, *first))) | |
| − | + | *out_true = *first, ++out_true; | |
| − | + | else | |
| + | *out_false = *first, ++out_false; | ||
| + | return {std::move(first), std::move(out_true), std::move(out_false)}; | ||
| + | } | ||
| − | + | template<ranges::input_range R, | |
| − | + | std::weakly_incrementable O1, std::weakly_incrementable O2, | |
| − | + | class Proj = std::identity, | |
| − | + | std::indirect_unary_predicate<std::projected<iterator_t<R>, Proj>> Pred> | |
| − | + | requires std::indirectly_copyable<ranges::iterator_t<R>, O1> && | |
| − | + | std::indirectly_copyable<ranges::iterator_t<R>, O2> | |
| − | + | constexpr ranges::partition_copy_result<ranges::borrowed_iterator_t<R>, O1, O2> | |
| − | + | operator()(R&& r, O1 out_true, O2 out_false, Pred pred, Proj proj = {}) const | |
| − | + | { | |
| − | + | return (*this)(ranges::begin(r), ranges::end(r), std::move(out_true), | |
| + | std::move(out_false), std::move(pred), std::move(proj)); | ||
| + | } | ||
}; | }; | ||
| − | inline constexpr partition_copy_fn partition_copy{}; | + | inline constexpr partition_copy_fn partition_copy {}; |
}} | }} | ||
| Line 92: | Line 99: | ||
#include <cctype> | #include <cctype> | ||
#include <iostream> | #include <iostream> | ||
| − | |||
#include <iterator> | #include <iterator> | ||
| + | #include <vector> | ||
int main() | int main() | ||
| Line 101: | Line 108: | ||
std::vector<int> o1(size(in)), o2(size(in)); | std::vector<int> o1(size(in)), o2(size(in)); | ||
| − | auto pred = [](char c){ return std::isalpha(c); }; | + | auto pred = [](char c) { return std::isalpha(c); }; |
auto ret = std::ranges::partition_copy(in, o1.begin(), o2.begin(), pred); | auto ret = std::ranges::partition_copy(in, o1.begin(), o2.begin(), pred); | ||
| Line 114: | Line 121: | ||
std::cout << '\n'; | std::cout << '\n'; | ||
} | } | ||
| − | | output= | + | |output= |
in = N 3 U M 1 B 4 E 1 5 R 9 | in = N 3 U M 1 B 4 E 1 5 R 9 | ||
o1 = N U M B E R | o1 = N U M B E R | ||
| Line 122: | Line 129: | ||
===See also=== | ===See also=== | ||
{{dsc begin}} | {{dsc begin}} | ||
| − | {{dsc inc | cpp/algorithm/ranges/dsc partition}} | + | {{dsc inc|cpp/algorithm/ranges/dsc partition}} |
| − | {{dsc inc | cpp/algorithm/ranges/dsc stable_partition}} | + | {{dsc inc|cpp/algorithm/ranges/dsc stable_partition}} |
| − | {{dsc inc | cpp/algorithm/ranges/dsc copy}} | + | {{dsc inc|cpp/algorithm/ranges/dsc copy}} |
| − | {{dsc inc | cpp/algorithm/ranges/dsc remove_copy}} | + | {{dsc inc|cpp/algorithm/ranges/dsc remove_copy}} |
| − | {{dsc inc | cpp/algorithm/dsc partition_copy}} | + | {{dsc inc|cpp/algorithm/dsc partition_copy}} |
{{dsc end}} | {{dsc end}} | ||
{{langlinks|de|es|fr|it|ja|pt|ru|zh}} | {{langlinks|de|es|fr|it|ja|pt|ru|zh}} | ||
Latest revision as of 10:26, 18 December 2023
| Defined in header <algorithm>
|
||
| Call signature |
||
| template< std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O1, std::weakly_incrementable O2, |
(1) | (since C++20) |
| template< ranges::input_range R, std::weakly_incrementable O1, std::weakly_incrementable O2, |
(2) | (since C++20) |
| Helper types |
||
| template< class I, class O1, class O2 > using partition_copy_result = ranges::in_out_out_result<I, O1, O2>; |
(3) | (since C++20) |
1) Copies the elements from the input range
[first, last) to two different output ranges depending on the value returned by the predicate pred. The elements that satisfy the predicate pred after projection by proj are copied to the range beginning at out_true. The rest of the elements are copied to the range beginning at out_false. The behavior is undefined if the input range overlaps either of the output ranges.2) Same as (1), but uses r as the source range, as if using ranges::begin(r) as first, and ranges::end(r) as last.
The function-like entities described on this page are niebloids, that is:
- Explicit template argument lists cannot be specified when calling any of them.
- None of them are visible to argument-dependent lookup.
- When any of them are found by normal unqualified lookup as the name to the left of the function-call operator, argument-dependent lookup is inhibited.
In practice, they may be implemented as function objects, or with special compiler extensions.
Contents |
[edit] Parameters
| first, last | - | the input range of elements to copy from |
| r | - | the input range of elements to copy from |
| out_true | - | the beginning of the output range for the elements that satisfy pred |
| out_false | - | the beginning of the output range for the elements that do not satisfy pred |
| pred | - | predicate to apply to the projected elements |
| proj | - | projection to apply to the elements |
[edit] Return value
{last, o1, o2}, where o1 and o2 are the ends of the output ranges respectively, after the copying is complete.
[edit] Complexity
Exactly ranges::distance(first, last) applications of the corresponding predicate comp and any projection proj.
[edit] Possible implementation
struct partition_copy_fn { template<std::input_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O1, std::weakly_incrementable O2, class Proj = std::identity, std::indirect_unary_predicate< std::projected<I, Proj>> Pred> requires std::indirectly_copyable<I, O1> && std::indirectly_copyable<I, O2> constexpr ranges::partition_copy_result<I, O1, O2> operator()(I first, S last, O1 out_true, O2 out_false, Pred pred, Proj proj = {}) const { for (; first != last; ++first) if (!!std::invoke(pred, std::invoke(proj, *first))) *out_true = *first, ++out_true; else *out_false = *first, ++out_false; return {std::move(first), std::move(out_true), std::move(out_false)}; } template<ranges::input_range R, std::weakly_incrementable O1, std::weakly_incrementable O2, class Proj = std::identity, std::indirect_unary_predicate<std::projected<iterator_t<R>, Proj>> Pred> requires std::indirectly_copyable<ranges::iterator_t<R>, O1> && std::indirectly_copyable<ranges::iterator_t<R>, O2> constexpr ranges::partition_copy_result<ranges::borrowed_iterator_t<R>, O1, O2> operator()(R&& r, O1 out_true, O2 out_false, Pred pred, Proj proj = {}) const { return (*this)(ranges::begin(r), ranges::end(r), std::move(out_true), std::move(out_false), std::move(pred), std::move(proj)); } }; inline constexpr partition_copy_fn partition_copy {}; |
[edit] Example
Run this code
#include <algorithm> #include <cctype> #include <iostream> #include <iterator> #include <vector> int main() { const auto in = {'N', '3', 'U', 'M', '1', 'B', '4', 'E', '1', '5', 'R', '9'}; std::vector<int> o1(size(in)), o2(size(in)); auto pred = [](char c) { return std::isalpha(c); }; auto ret = std::ranges::partition_copy(in, o1.begin(), o2.begin(), pred); std::ostream_iterator<char> cout {std::cout, " "}; std::cout << "in = "; std::ranges::copy(in, cout); std::cout << "\no1 = "; std::copy(o1.begin(), ret.out1, cout); std::cout << "\no2 = "; std::copy(o2.begin(), ret.out2, cout); std::cout << '\n'; }
Output:
in = N 3 U M 1 B 4 E 1 5 R 9 o1 = N U M B E R o2 = 3 1 4 1 5 9
[edit] See also
| (C++20) |
divides a range of elements into two groups (niebloid) |
| (C++20) |
divides elements into two groups while preserving their relative order (niebloid) |
| (C++20)(C++20) |
copies a range of elements to a new location (niebloid) |
| (C++20)(C++20) |
copies a range of elements omitting those that satisfy specific criteria (niebloid) |
| (C++11) |
copies a range dividing the elements into two groups (function template) |
