Difference between revisions of "cpp/algorithm/partition"

Latest revision as of 00:08, 29 March 2024

Defined in header `<algorithm>`
template< class ForwardIt, class UnaryPred > ForwardIt partition( ForwardIt first, ForwardIt last, UnaryPred p );	(1)	(constexpr since C++20)
template< class ExecutionPolicy, class ForwardIt, class UnaryPred > ForwardIt partition( ExecutionPolicy&& policy, ForwardIt first, ForwardIt last, UnaryPred p );	(2)	(since C++17)

1) Reorders the elements in the range [first, last) in such a way that all elements for which the predicate p returns true precede all elements for which predicate p returns false. Relative order of the elements is not preserved.

2) Same as (1), but executed according to policy.

This overload participates in overload resolution only if

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true.	(until C++20)
std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> is true.	(since C++20)

If the type of *first is not Swappable(until C++11)ForwardIt is not ValueSwappable(since C++11), the behavior is undefined.

first, last	-	the range of elements to reorder
policy	-	the execution policy to use. See execution policy for details.
p	-	unary predicate which returns true if the element should be ordered before other elements. The expression p(v) must be convertible to bool for every argument `v` of type (possibly const) `VT`, where `VT` is the value type of `ForwardIt`, regardless of value category, and must not modify `v`. Thus, a parameter type of VT&is not allowed, nor is VT unless for `VT` a move is equivalent to a copy(since C++11).
Type requirements
- `ForwardIt` must meet the requirements of LegacyForwardIterator.
- `UnaryPred` must meet the requirements of Predicate.

[edit] Return value

Iterator to the first element of the second group.

[edit] Complexity

Given $\scriptsize N$ $N$ as std::distance(first, last):

1) Exactly

N

applications of p.

At most

N/2

swaps if ForwardIt meets the requirements of LegacyBidirectionalIterator, and at most

N

swaps otherwise.

2)

O(N)

applications of p.

O(N\cdotlog(N))

swaps.

[edit] Exceptions

The overload with a template parameter named ExecutionPolicy reports errors as follows:

If execution of a function invoked as part of the algorithm throws an exception and ExecutionPolicy is one of the standard policies, std::terminate is called. For any other ExecutionPolicy, the behavior is implementation-defined.
If the algorithm fails to allocate memory, std::bad_alloc is thrown.

[edit] Possible implementation

Implements overload (1) preserving C++11 compatibility.

template<class ForwardIt, class UnaryPred>
ForwardIt partition(ForwardIt first, ForwardIt last, UnaryPred p)
{
    first = std::find_if_not(first, last, p);
    if (first == last)
        return first;
 
    for (auto i = std::next(first); i != last; ++i)
        if (p(*i))
        {
            std::iter_swap(i, first);
            ++first;
        }
 
    return first;
}

[edit] Example

Run this code

#include <algorithm>
#include <forward_list>
#include <iostream>
#include <iterator>
#include <vector>
 
template<class ForwardIt>
void quicksort(ForwardIt first, ForwardIt last)
{
    if (first == last)
        return;
 
    auto pivot = *std::next(first, std::distance(first, last) / 2);
    auto middle1 = std::partition(first, last, [pivot](const auto& em)
    {
        return em < pivot;
    });
    auto middle2 = std::partition(middle1, last, [pivot](const auto& em)
    {
        return !(pivot < em);
    });
 
    quicksort(first, middle1);
    quicksort(middle2, last);
}
 
int main()
{
    std::vector<int> v{0, 1, 2, 3, 4, 5, 6, 7, 8, 9};
    std::cout << "Original vector: ";
    for (int elem : v)
        std::cout << elem << ' ';
 
    auto it = std::partition(v.begin(), v.end(), [](int i) {return i % 2 == 0;});
 
    std::cout << "\nPartitioned vector: ";
    std::copy(std::begin(v), it, std::ostream_iterator<int>(std::cout, " "));
    std::cout << "* ";
    std::copy(it, std::end(v), std::ostream_iterator<int>(std::cout, " "));
 
    std::forward_list<int> fl {1, 30, -4, 3, 5, -4, 1, 6, -8, 2, -5, 64, 1, 92};
    std::cout << "\nUnsorted list: ";
    for (int n : fl)
        std::cout << n << ' ';
 
    quicksort(std::begin(fl), std::end(fl));
    std::cout << "\nSorted using quicksort: ";
    for (int fi : fl)
        std::cout << fi << ' ';
    std::cout << '\n';
}

Possible output:

Original vector: 0 1 2 3 4 5 6 7 8 9 
Partitioned vector: 0 8 2 6 4 * 5 3 7 1 9 
Unsorted list: 1 30 -4 3 5 -4 1 6 -8 2 -5 64 1 92 
Sorted using quicksort: -8 -5 -4 -4 1 1 1 2 3 5 6 30 64 92

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
LWG 498	C++98	`std::partition` required first and last to be LegacyBidirectionalIterator	only required to be LegacyForwardIterator
LWG 2150	C++98	`std::partition` was only required to place one element satisfying p before one element not satisfying p	corrected the requirement

[edit] See also

is_partitioned (C++11)	determines if the range is partitioned by the given predicate (function template) [edit]
stable_partition	divides elements into two groups while preserving their relative order (function template) [edit]
ranges::partition (C++20)	divides a range of elements into two groups (niebloid)[edit]

@@ Line 2: / Line 2: @@
 {{cpp/algorithm/navbar}}
 {{dcl begin}}
-{{dcl header | algorithm}}
+{{dcl header|algorithm}}
-{{dcl rev begin| num=1}}
+{{dcl|num=1|notes={{mark constexpr since c++20}}|
-{{dcl | until=c++11 |
+template< class ForwardIt, class UnaryPred >
-template< class BidirIt, class UnaryPredicate >
+ForwardIt partition( ForwardIt first, ForwardIt last, UnaryPred p );
-BidirIt partition( BidirIt first, BidirIt last, UnaryPredicate p );
 }}
-{{dcl|since=c++11|until=c++20|1=
+{{dcl|num=2|since=c++17|
-template< class ForwardIt, class UnaryPredicate >
+template< class ExecutionPolicy, class ForwardIt, class UnaryPred >
-ForwardIt partition( ForwardIt first, ForwardIt last, UnaryPredicate p );
-}}
-{{dcl|since=c++20|1=
-template< class ForwardIt, class UnaryPredicate >
-constexpr ForwardIt partition( ForwardIt first, ForwardIt last, UnaryPredicate p );
-}}
-{{dcl rev end}}
-{{dcl | since=c++17 | num= 2 |1=
-template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate >
 ForwardIt partition( ExecutionPolicy&& policy,
-                      ForwardIt first, ForwardIt last, UnaryPredicate p );}}
+                      ForwardIt first, ForwardIt last, UnaryPred p );
+}}
 {{dcl end}}
-@1@ Reorders the elements in the range {{tt|[first, last)}} in such a way that all elements for which the predicate {{tt|p}} returns {{c|true}} precede the elements for which predicate {{tt|p}} returns {{c|false}}. Relative order of the elements is not preserved.
+@1@ Reorders the elements in the range {{range|first|last}} in such a way that all elements for which the predicate {{c|p}} returns {{c|true}} precede all elements for which predicate {{c|p}} returns {{c|false}}. Relative order of the elements is not preserved.
+@2@ Same as {{v|1}}, but executed according to {{c|policy}}.
+@@ {{cpp/algorithm/parallel overload precondition}}
-@2@ Same as {{v|1}}, but executed according to {{tt|policy}}. This overload does not participate in overload resolution unless {{c|std::is_execution_policy_v<std::decay_t<ExecutionPolicy>>}} is true
+If {{rev inl|until=c++11|the type of {{c|*first}} is not {{named req|Swappable}}}}{{rev inl|since=c++11|{{tt|ForwardIt}} is not {{named req|ValueSwappable}}}}, the behavior is undefined.
 ===Parameters===
 {{par begin}}
-{{par | first, last | the range of elements to reorder}}
+{{par|first, last|the range of elements to reorder}}
 {{par exec pol}}
-{{par pred1 | p | if the element should be ordered before other elements | p1=ForwardIt}}
+{{par pred1|p|if the element should be ordered before other elements|p1=ForwardIt}}
 {{par hreq}}
-{{par req concept | BidirIt | BidirectionalIterator}}
+{{par req named|ForwardIt|ForwardIterator}}
-{{par req concept | ForwardIt | ForwardIterator | ValueSwappable | notes=However, the operation is more efficient if {{tt|ForwardIt}} also satisfies the requirements of {{named req|BidirectionalIterator}}}}
+{{par req named|UnaryPred|Predicate}}
-{{par req concept | UnaryPredicate | Predicate}}
 {{par end}}
@@ Line 42: / Line 35: @@
 ===Complexity===
-Given N = {{c|std::distance(first,last)}},
+Given {{mathjax-or|\(\scriptsize N\)|N}} as {{c|std::distance(first, last)}}:
-@1@ Exactly N applications of the predicate. At most N/2 swaps if {{tt|ForwardIt}} meets the requirements of {{named req|BidirectionalIterator}}, and at most N swaps otherwise.
-@2@ {{tt|O(N log N)}} swaps {{tt|and O(N)}} applications of the predicate.
+@1@ Exactly {{mathjax-or|\(\scriptsize N\)|N}} applications of {{c|p}}.
+@@ At most {{mathjax-or|\(\scriptsize N/2\)|N/2}} swaps if {{tt|ForwardIt}} meets the requirements of {{named req|BidirectionalIterator}}, and at most {{mathjax-or|\(\scriptsize N\)|N}} swaps otherwise.
+@2@ {{mathjax-or|\(\scriptsize O(N)\)|O(N)}} applications of {{c|p}}.
+@@ {{mathjax-or|\(\scriptsize O(N \cdot log(N))\)|O(N·log(N))}} swaps.
 ===Exceptions===
-{{cpp/algorithm/parallel_exceptions_reporting_behavior|singular=yes}}
+{{cpp/algorithm/parallel exceptions reporting behavior|singular=yes}}
 ===Possible implementation===
-{{eq fun | 1=
+Implements overload {{v|1}} preserving C++11 compatibility.
-template<class ForwardIt, class UnaryPredicate>
+{{eq fun|1=
-ForwardIt partition(ForwardIt first, ForwardIt last, UnaryPredicate p)
+template<class ForwardIt, class UnaryPred>
+ForwardIt partition(ForwardIt first, ForwardIt last, UnaryPred p)
 {
      first = std::find_if_not(first, last, p);
-     if (first == last) return first;
+     if (first == last)
+        return first;
-     for (ForwardIt i = std::next(first); i != last; ++i) {
-         if (p(*i)) {
+     for (auto i = std::next(first); i != last; ++i)
+         if (p(*i))
+        {
              std::iter_swap(i, first);
              ++first;
          }
-     }
      return first;
 }
 }}
 ===Example===
 {{example
- |
+|
- | code=
+|code=
 #include <algorithm>
+#include <forward_list>
 #include <iostream>
 #include <iterator>
 #include <vector>
-#include <forward_list>
-template <class ForwardIt>
+template<class ForwardIt>
- void quicksort(ForwardIt first, ForwardIt last)
+void quicksort(ForwardIt first, ForwardIt last)
- {
+{
-     if(first == last) return;
+     if (first == last)
-     auto pivot = *std::next(first, std::distance(first,last)/2);
+        return;
-     ForwardIt middle1 = std::partition(first, last,
-                         [pivot](const auto& em){ return em < pivot; });
+     auto pivot = *std::next(first, std::distance(first, last) / 2);
-     ForwardIt middle2 = std::partition(middle1, last,
+     auto middle1 = std::partition(first, last, [pivot](const auto& em)
-                         [pivot](const auto& em){ return !(pivot < em); });
+    {
+        return em < pivot;
+    });
+     auto middle2 = std::partition(middle1, last, [pivot](const auto& em)
+    {
+        return !(pivot < em);
+    });
      quicksort(first, middle1);
      quicksort(middle2, last);
- }
+}
 int main()
 {
-     std::vector<int> v = {0,1,2,3,4,5,6,7,8,9};
+     std::vector<int> v{0, 1, 2, 3, 4, 5, 6, 7, 8, 9};
-     std::cout << "Original vector:\n    ";
+     std::cout << "Original vector: ";
-     for(int elem : v) std::cout << elem << ' ';
+     for (int elem : v)
+        std::cout << elem << ' ';
-     auto it = std::partition(v.begin(), v.end(), [](int i){return i % 2 == 0;});
+     auto it = std::partition(v.begin(), v.end(), [](int i) {return i % 2 == 0;});
-     std::cout << "\nPartitioned vector:\n    ";
+     std::cout << "\nPartitioned vector: ";
      std::copy(std::begin(v), it, std::ostream_iterator<int>(std::cout, " "));
-     std::cout << " * ";
+     std::cout << "* ";
      std::copy(it, std::end(v), std::ostream_iterator<int>(std::cout, " "));
-     std::forward_list<int> fl = {1, 30, -4, 3, 5, -4, 1, 6, -8, 2, -5, 64, 1, 92};
+     std::forward_list<int> fl {1, 30, -4, 3, 5, -4, 1, 6, -8, 2, -5, 64, 1, 92};
-     std::cout << "\nUnsorted list:\n    ";
+     std::cout << "\nUnsorted list: ";
-     for(int n : fl) std::cout << n << ' ';
+     for (int n : fl)
-     std::cout << '\n';
+        std::cout << n << ' ';
      quicksort(std::begin(fl), std::end(fl));
-     std::cout << "Sorted using quicksort:\n    ";
+     std::cout << "\nSorted using quicksort: ";
-     for(int fi : fl) std::cout << fi << ' ';
+     for (int fi : fl)
+        std::cout << fi << ' ';
      std::cout << '\n';
 }
-| output =
+|p=true
-Original vector:
+|output=
-1 2 3 4 5 6 7 8 9
+Original vector: 0 1 2 3 4 5 6 7 8 9
-Partitioned vector:
+Partitioned vector: 0 8 2 6 4 * 5 3 7 1 9
-8 2 6 4  *  5 3 7 1 9
+Unsorted list: 1 30 -4 3 5 -4 1 6 -8 2 -5 64 1 92
-Unsorted list:
+Sorted using quicksort: -8 -5 -4 -4 1 1 1 2 3 5 6 30 64 92
-30 -4 3 5 -4 1 6 -8 2 -5 64 1 92
-Sorted using quicksort:
-    -8 -5 -4 -4 1 1 1 2 3 5 6 30 64 92
 }}
+===Defect reports===
+{{dr list begin}}
+{{dr list item|wg=lwg|dr=498|std=C++98|before={{tt|std::partition}} required {{c|first}} and<br>{{c|last}} to be {{named req|BidirectionalIterator}}|after=only required to be<br>{{named req|ForwardIterator}}}}
+{{dr list item|wg=lwg|dr=2150|std=C++98|before={{tt|std::partition}} was only required to place one element<br>satisfying {{c|p}} before one element not satisfying {{c|p}}|after=corrected the<br>requirement}}
+{{dr list end}}
 ===See also===
 {{dsc begin}}
-{{dsc inc | cpp/algorithm/dsc is_partitioned}}
+{{dsc inc|cpp/algorithm/dsc is_partitioned}}
-{{dsc inc | cpp/algorithm/dsc stable_partition}}
+{{dsc inc|cpp/algorithm/dsc stable_partition}}
+{{dsc inc|cpp/algorithm/ranges/dsc partition}}
 {{dsc end}}
-[[de:cpp/algorithm/partition]]
+{{langlinks|de|es|fr|it|ja|pt|ru|zh}}
-[[es:cpp/algorithm/partition]]
-[[fr:cpp/algorithm/partition]]
-[[it:cpp/algorithm/partition]]
-[[ja:cpp/algorithm/partition]]
-[[pt:cpp/algorithm/partition]]
-[[ru:cpp/algorithm/partition]]
-[[zh:cpp/algorithm/partition]]

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Metaprogramming library (C++11)
Diagnostics library
General utilities library
Strings library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Numerics library
Localizations library
Input/output library
Filesystem library (C++17)
Regular expressions library (C++11)
Concurrency support library (C++11)
Execution support library (C++26)
Technical specifications
Symbols index
External libraries

cppreference.com

Namespaces

Variants

Views

Actions

Difference between revisions of "cpp/algorithm/partition"

Latest revision as of 00:08, 29 March 2024

Contents

[edit] Parameters