Namespaces
Variants
Views
Actions

Difference between revisions of "cpp/algorithm/partition"

From cppreference.com
< cpp‎ | algorithm
m (Minor fix.)
(Added LWG issue #2150 DR (part 6/12), and uses {{mark constexpr since c++20}}.)
 
(3 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
{{dcl begin}}
 
{{dcl begin}}
 
{{dcl header|algorithm}}
 
{{dcl header|algorithm}}
−
{{dcl rev multi|num=1
+
{{dcl|num=1|notes={{mark constexpr since c++20}}|
−
|dcl1=
+
template< class ForwardIt, class UnaryPred >
−
template< class ForwardIt, class UnaryPredicate >
+
ForwardIt partition( ForwardIt first, ForwardIt last, UnaryPred p );
−
ForwardIt partition( ForwardIt first, ForwardIt last, UnaryPredicate p );
+
−
|since2=c++20|dcl2=
+
−
template< class ForwardIt, class UnaryPredicate >
+
−
constexpr ForwardIt partition( ForwardIt first, ForwardIt last,
+
−
                              UnaryPredicate p );
+
 
}}
 
}}
−
{{dcl|num=2|since=c++17|1=
+
{{dcl|num=2|since=c++17|
−
template< class ExecutionPolicy, class ForwardIt, class UnaryPredicate >
+
template< class ExecutionPolicy, class ForwardIt, class UnaryPred >
 
ForwardIt partition( ExecutionPolicy&& policy,  
 
ForwardIt partition( ExecutionPolicy&& policy,  
−
                     ForwardIt first, ForwardIt last, UnaryPredicate p );}}
+
                     ForwardIt first, ForwardIt last, UnaryPred p );
 +
}}
 
{{dcl end}}
 
{{dcl end}}
  
−
@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 the elements for which predicate {{c|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 {{c|policy}}.
 +
@@ {{cpp/algorithm/parallel overload precondition}}
 +
 
 +
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===
 
===Parameters===
Line 28: Line 27:
 
{{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 hreq}}
−
{{par req named|ForwardIt|ForwardIterator|ValueSwappable|notes=However, the operation is more efficient if {{tt|ForwardIt}} also satisfies the requirements of {{named req|BidirectionalIterator}}.}}
+
{{par req named|ForwardIt|ForwardIterator}}
−
{{par req named|UnaryPredicate|Predicate}}
+
{{par req named|UnaryPred|Predicate}}
 
{{par end}}
 
{{par end}}
  
Line 36: Line 35:
  
 
===Complexity===
 
===Complexity===
−
Given {{tt|N}} = {{c|std::distance(first, last)}},
+
Given {{mathjax-or|\(\scriptsize N\)|N}} as {{c|std::distance(first, last)}}:
−
@1@ Exactly {{tt|N}} applications of {{c|p}}. At most {{tt|N/2}} swaps if {{tt|ForwardIt}} meets the requirements of {{named req|BidirectionalIterator}}, and at most N swaps otherwise.
+
 
−
@2@ {{tt|O(N&middot;log N)}} swaps and {{tt|O(N)}} applications of {{c|p}}.
+
@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===
 
===Exceptions===
Line 46: Line 49:
 
Implements overload {{v|1}} preserving C++11 compatibility.
 
Implements overload {{v|1}} preserving C++11 compatibility.
 
{{eq fun|1=
 
{{eq fun|1=
−
template<class ForwardIt, class UnaryPredicate>
+
template<class ForwardIt, class UnaryPred>
−
ForwardIt partition(ForwardIt first, ForwardIt last, UnaryPredicate p)
+
ForwardIt partition(ForwardIt first, ForwardIt last, UnaryPred p)
 
{
 
{
 
     first = std::find_if_not(first, last, p);
 
     first = std::find_if_not(first, last, p);
Line 54: Line 57:
 
      
 
      
 
     for (auto i = std::next(first); i != last; ++i)
 
     for (auto i = std::next(first); i != last; ++i)
−
    {
 
 
         if (p(*i))
 
         if (p(*i))
 
         {
 
         {
Line 60: Line 62:
 
             ++first;
 
             ++first;
 
         }
 
         }
−
    }
 
 
      
 
      
 
     return first;
 
     return first;
Line 76: Line 77:
 
#include <vector>
 
#include <vector>
  
−
template <class ForwardIt>
+
template<class ForwardIt>
 
void quicksort(ForwardIt first, ForwardIt last)
 
void quicksort(ForwardIt first, ForwardIt last)
 
{
 
{
Line 98: Line 99:
 
int main()
 
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)
 
     for (int elem : v)
 
         std::cout << elem << ' ';
 
         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::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::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)
 
     for (int n : fl)
 
         std::cout << n << ' ';
 
         std::cout << n << ' ';
−
    std::cout << '\n'; 
 
 
      
 
      
 
     quicksort(std::begin(fl), std::end(fl));
 
     quicksort(std::begin(fl), std::end(fl));
−
     std::cout << "Sorted using quicksort:\n    ";
+
     std::cout << "\nSorted using quicksort: ";
 
     for (int fi : fl)
 
     for (int fi : fl)
 
         std::cout << fi << ' ';
 
         std::cout << fi << ' ';
Line 124: Line 124:
 
|p=true
 
|p=true
 
|output=
 
|output=
−
Original vector:
+
Original vector: 0 1 2 3 4 5 6 7 8 9  
−
    0 1 2 3 4 5 6 7 8 9  
+
Partitioned vector: 0 8 2 6 4 * 5 3 7 1 9  
−
Partitioned vector:
+
Unsorted list: 1 30 -4 3 5 -4 1 6 -8 2 -5 64 1 92  
−
    0 8 2 6 4 * 5 3 7 1 9  
+
Sorted using quicksort: -8 -5 -4 -4 1 1 1 2 3 5 6 30 64 92  
−
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  
+
 
}}
 
}}
  
 
===Defect reports===
 
===Defect reports===
 
{{dr list begin}}
 
{{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 {{named req|ForwardIterator}} (the complexity<br>requirement for non-bidirectional iterators are weaker)}}
+
{{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}}
 
{{dr list end}}
  

Latest revision as of 00:08, 29 March 2024

 
C++
 
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
(C++11)                (C++11)(C++11)

Modifying sequence operations
Copy operations
(C++11)
(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
partition
(C++11)  
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
(C++11)
(C++17)
Lexicographical comparison operations
(C++20)
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
 
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.

Contents

[edit] Parameters

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 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·log(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

(C++11)
 determines if the range is partitioned by the given predicate
(function template) [edit]
divides elements into two groups while preserving their relative order
(function template) [edit]
(C++20)
 divides a range of elements into two groups
(niebloid)[edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=cpp/algorithm/partition&oldid=170526"