std::next_permutation (3) - Linux Man Pages

std::next_permutation: std::next_permutation

NAME

std::next_permutation - std::next_permutation

Synopsis


Defined in header <algorithm>
template< class BidirIt > (until C++20)
bool next_permutation( BidirIt first, BidirIt last );
template< class BidirIt > (since C++20)
constexpr bool next_permutation( BidirIt first, BidirIt last ); (1)
template< class BidirIt, class Compare > (until C++20)
bool next_permutation( BidirIt first, BidirIt last, Compare comp ); (2)
template< class BidirIt, class Compare > (since C++20)
constexpr bool next_permutation( BidirIt first, BidirIt last, Compare comp );


Transforms the range [first, last) into the next permutation from the set of all permutations that are lexicographically ordered with respect to operator< or comp. Returns true if such permutation exists, otherwise transforms the range into the first permutation (as if by std::sort(first, last)) and returns false.

Parameters


first, last - the range of elements to permute
              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:
              bool cmp(const Type1 &a, const Type2 &b);
comp - 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 ValueSwappable and 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.

Exceptions


Any exceptions thrown from iterator operations or the element swap.

Complexity


At most N/2 swaps, where N = std::distance(first, last). Averaged over the entire sequence of permutations, typical implementations use about 3 comparisons and 1.5 swaps per call.

Possible implementation


  template<class BidirIt>
  bool next_permutation(BidirIt first, BidirIt last)
  {
      if (first == last) return false;
      BidirIt i = last;
      if (first == --i) return false;


      while (true) {
          BidirIt i1, i2;


          i1 = i;
          if (*--i < *i1) {
              i2 = last;
              while (!(*i < *--i2))
                  ;
              std::iter_swap(i, i2);
              std::reverse(i1, last);
              return true;
          }
          if (i == first) {
              std::reverse(first, last);
              return false;
          }
      }
  }

Example


The following code prints all three permutations of the string "aba"
// Run this code


  #include <algorithm>
  #include <string>
  #include <iostream>


  int main()
  {
      std::string s = "aba";
      std::sort(s.begin(), s.end());
      do {
          std::cout << s << '\n';
      } while(std::next_permutation(s.begin(), s.end()));
  }

Output:


  aab
  aba
  baa

See also


is_permutation determines if a sequence is a permutation of another sequence
                 (function template)
(C++11)
                 generates the next smaller lexicographic permutation of a range of elements
prev_permutation (function template)