std::next_permutation - cppreference.com

From cppreference.com

Defined in header

<algorithm>

template<classBidirIt>boolnext_permutation(BidirItfirst,BidirItlast); (1) (constexpr since C++20)template<classBidirIt,classCompare>boolnext_permutation(BidirItfirst,BidirItlast,Comparecomp); (2) (constexpr since C++20)Permutes the range [first, last) into the next

permutation

. Returns true if such a “next permutation” exists; otherwise transforms the range into the lexicographically first permutation (an ascending order) and returns false.

1) The set of all permutations is ordered lexicographically with respect to operator<(until C++20)std::less{}(since C++20).

2) The set of all permutations is ordered lexicographically with respect to 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

range

of elements to permute 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:

boolcmp(constType1&a,constType2&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) Type1 and Type2 regardless of

value category

(thus, Type1& is not allowed, nor is Type1 unless for Type1 a move is equivalent to a copy(since C++11)).
The types Type1 and Type2 must be such that an object of type BidirIt can be dereferenced and then implicitly converted to both of them.

Type requirements -BidirIt must meet the requirements of

LegacyBidirectionalIterator

. Return value

true if the new permutation is lexicographically greater than the old. false if the last permutation was reached and the range was reset to the first permutation.

Complexity

Given N as std::distance(first,last):

1,2) At most N2 swaps.

Exceptions

Any exceptions thrown from iterator operations or the element swap.

Possible implementation

template<classBidirIt>boolnext_permutation(BidirItfirst,BidirItlast){autor_first=std::make_reverse_iterator(last);autor_last=std::make_reverse_iterator(first);autoleft=std::is_sorted_until(r_first,r_last);if(left!=r_last){autoright=std::upper_bound(r_first,left,*left);std::iter_swap(left,right);}std::reverse(left.base(),last);returnleft!=r_last;}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.

Example

The following code prints all permutations of a string.

Run this code

#include<algorithm>#include<cassert>#include<iostream>#include<string>intmain(){std::strings="ABBA";std::sort(s.begin(),s.end());dostd::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