std:: stable_sort
Defined in header
<algorithm>
|
||
template
<
class
RandomIt
>
void stable_sort ( RandomIt first, RandomIt last ) ; |
(1) | (constexpr since C++26) |
template
<
class
ExecutionPolicy,
class
RandomIt
>
void
stable_sort
(
ExecutionPolicy
&&
policy,
|
(2) | (since C++17) |
template
<
class
RandomIt,
class
Compare
>
void stable_sort ( RandomIt first, RandomIt last, Compare comp ) ; |
(3) | (constexpr since C++26) |
template
<
class
ExecutionPolicy,
class
RandomIt,
class
Compare
>
void
stable_sort
(
ExecutionPolicy
&&
policy,
|
(4) | (since C++17) |
Sorts the elements in the range
[
first
,
last
)
in non-descending order. The order of equivalent elements is guaranteed to be preserved.
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 any of the following conditions is satisfied, the behavior is undefined:
|
(until C++11) |
|
(since C++11) |
Parameters
first, last | - | the range of elements to sort |
policy | - | the execution policy to use. See execution policy for details. |
comp | - |
comparison function object (i.e. an object that satisfies the requirements of
Compare
) which returns
true
if the first argument is
less
than (i.e. is ordered
before
) the second.
The signature of the comparison function should be equivalent to the following: bool cmp ( const Type1 & a, const Type2 & b ) ;
While the signature does not need to have
const
&
, the function must not modify the objects passed to it and must be able to accept all values of type (possibly const)
|
Type requirements | ||
-
RandomIt
must meet the requirements of
LegacyRandomAccessIterator
.
|
||
-
Compare
must meet the requirements of
Compare
.
|
Complexity
Given N as last - first :
Exceptions
The overloads with a template parameter named
ExecutionPolicy
report 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 otherExecutionPolicy
, the behavior is implementation-defined. - If the algorithm fails to allocate memory, std::bad_alloc is thrown.
Possible implementation
See also the implementations in libstdc++ and libc++ .
Notes
This function attempts to allocate a temporary buffer equal in size to the sequence to be sorted. If the allocation fails, the less efficient algorithm is chosen.
Feature-test macro | Value | Std | Feature |
---|---|---|---|
__cpp_lib_constexpr_algorithms
|
202306L | (C++26) | constexpr stable sorting, overloads ( 1 ) , ( 3 ) |
Example
#include <algorithm> #include <array> #include <iostream> #include <string> #include <vector> struct Employee { int age; std::string name; // Does not participate in comparisons }; bool operator<(const Employee& lhs, const Employee& rhs) { return lhs.age < rhs.age; } #if __cpp_lib_constexpr_algorithms >= 202306L consteval auto get_sorted() { auto v = std::array{3, 1, 4, 1, 5, 9}; std::stable_sort(v.begin(), v.end()); return v; } static_assert(std::ranges::is_sorted(get_sorted())); #endif int main() { std::vector<Employee> v{{108, "Zaphod"}, {32, "Arthur"}, {108, "Ford"}}; std::stable_sort(v.begin(), v.end()); for (const Employee& e : v) std::cout << e.age << ", " << e.name << '\n'; }
Output:
32, Arthur 108, Zaphod 108, Ford
See also
sorts a range into ascending order
(function template) |
|
sorts the first N elements of a range
(function template) |
|
divides elements into two groups while preserving their relative order
(function template) |
|
(C++20)
|
sorts a range of elements while preserving order between equal elements
(algorithm function object) |