std::next_permutation
| Defined in header <algorithm>
|
||
template< class BidirIt >
bool next_permutation( BidirIt first, BidirIt last );
|
(1) | (constexpr since C++20) |
template< class BidirIt, class Compare >
bool next_permutation( BidirIt first, BidirIt last, Compare comp );
|
(2) | (constexpr since C++20) |
Permutes the target range [first, last) into the lexicographically next permutation. If the next permutation does not exist, transforms the range into the lexicographically first permutation.
operator<(until C++20)std::less{}(since C++20).comp.If the type of *first is not Swappable(until C++11)BidirIt is not ValueSwappable(since C++11), the behavior is undefined.
Parameters
| first, last | - | the pair of iterators defining the target range |
| comp | - | comparison function object (i.e. an object that satisfies the requirements of Compare) which returns true if the first argument is less than the second.The signature of the comparison function should be equivalent to the following:
While the signature does not need to have |
| Type requirements | ||
-BidirIt must meet the requirements of LegacyBidirectionalIterator.
| ||
Return value
true if the target range is permuted into the next permutation, otherwise false.
Complexity
Given N as std::distance(first, last):
| N |
| 2 |
Exceptions
Any exceptions thrown from iterator operations or the element swap.
Notes
Averaged over the entire sequence of permutations, typical implementations use about 3 comparisons and 1.5 swaps per call.
Implementations (e.g. MSVC STL) may enable vectorization when the iterator type satisfies LegacyContiguousIterator and swapping its value type calls neither non-trivial special member function nor ADL-found swap.
Possible implementation
template<class BidirIt>
bool next_permutation(BidirIt first, BidirIt last)
{
auto r_first = std::make_reverse_iterator(last);
auto r_last = std::make_reverse_iterator(first);
auto left = std::is_sorted_until(r_first, r_last);
if (left != r_last)
{
auto right = std::upper_bound(r_first, left, *left);
std::iter_swap(left, right);
}
std::reverse(left.base(), last);
return left != r_last;
}
|
Example
The following code prints all permutations of a string.
#include <algorithm>
#include <cassert>
#include <iostream>
#include <string>
int main()
{
std::string s = "ABBA";
std::sort(s.begin(), s.end());
do
std::cout << s << '\n';
while (std::next_permutation(s.begin(), s.end()));
assert(std::is_sorted(s.begin(), s.end()));
}
Output:
AABB
ABAB
ABBA
BAAB
BABA
BBAA
See also
(C++20) |
generates the next greater lexicographic permutation of a range of elements (algorithm function object) |
(C++11) |
determines if a sequence is a permutation of another sequence (function template & algorithm function object) |
(C++20) |
|
| generates the next smaller lexicographic permutation of a range of elements (function template & algorithm function object) | |
(C++20) |