std::prev_permutation

 

C++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (C++20)

Language support library

Concepts library (C++20)

Metaprogramming library (C++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (C++17)

Regular expressions library (C++11)

Concurrency support library (C++11)

Execution support library (C++26)

Technical specifications

Symbols index

External libraries

 

Algorithm library

Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
is_execution_policy (C++17)   execution::seqexecution::parexecution::par_unseqexecution::unseq (C++17)    (C++17)(C++17)(C++20)	execution::sequenced_policyexecution::parallel_policyexecution::parallel_unsequenced_policyexecution::parallel_unsequenced (C++17)(C++17)(C++17)(C++20)
Non-modifying sequence operations Batch operations for_each for_each_n (C++17) Search operations all_ofany_ofnone_of (C++11)                (C++11)(C++11) countcount_if mismatch equal findfind_iffind_if_not (C++11) find_end find_first_of adjacent_find search search_n Modifying sequence operations Copy operations copycopy_if (C++11) copy_backward copy_n (C++11) move (C++11) move_backward (C++11) Swap operations swap iter_swap swap_ranges Transformation operations replacereplace_if transform replace_copyreplace_copy_if Generation operations fill fill_n generate generate_n Removing operations removeremove_if unique remove_copyremove_copy_if unique_copy Order-changing operations reverse reverse_copy rotate rotate_copy random_shuffleshuffle (until C++17)(C++11) shift_leftshift_right (C++20)(C++20) Sampling operations sample (C++17)	Sorting and related operations Partitioning operations partition partition_copy (C++11)   stable_partition is_partitioned (C++11) partition_point (C++11) Sorting operations sort stable_sort partial_sort partial_sort_copy is_sorted (C++11) is_sorted_until (C++11) nth_element Binary search operations (on partitioned ranges) lower_bound upper_bound equal_range binary_search Set operations (on sorted ranges) includes set_union set_intersection set_difference set_symmetric_difference Merge operations (on sorted ranges) merge inplace_merge Heap operations push_heap pop_heap make_heap sort_heap is_heap (C++11) is_heap_until (C++11) Minimum/maximum operations max min minmax (C++11) clamp (C++17) max_element min_element minmax_element (C++11) Lexicographical comparison operations lexicographical_compare lexicographical_compare_three_way (C++20) Permutation operations next_permutation prev_permutation is_permutation (C++11) C library qsort bsearch
Numeric operations
iota (C++11) inner_product adjacent_difference    accumulate reduce (C++17) transform_reduce (C++17)	partial_sum inclusive_scan (C++17)    exclusive_scan (C++17) transform_inclusive_scan (C++17) transform_exclusive_scan (C++17)
Operations on uninitialized memory
uninitialized_copy uninitialized_move (C++17)    uninitialized_fill uninitialized_copy_n (C++11) uninitialized_move_n (C++17) uninitialized_fill_n	destroy (C++17) destroy_n (C++17) destroy_at (C++17) construct_at (C++20)       uninitialized_default_construct (C++17) uninitialized_value_construct (C++17) uninitialized_default_construct_n (C++17) uninitialized_value_construct_n (C++17)

 

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

Transforms the range [first, last) into the previous permutation. Returns true if such permutation exists, otherwise transforms the range into the last permutation (as if by std::sort followed by std::reverse) 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 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: 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) 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 precedes the old in lexicographical order. false if the first permutation was reached and the range was reset to the last permutation.

Exceptions

Any exceptions thrown from iterator operations or the element swap.

Complexity

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

1,2) At most \(\scriptsize \frac{N}{2}\)

N

2

swaps.

Possible implementation

template<class BidirIt> bool prev_permutation(BidirIt first, BidirIt last) { if (first == last) return false; BidirIt i = last; if (first == --i) return false;   while (1) { BidirIt i1, i2;   i1 = i; if (*i1 < *--i) { i2 = last; while (!(*--i2 < *i)) ; std::iter_swap(i, i2); std::reverse(i1, last); return true; }   if (i == first) { std::reverse(first, last); return false; } } }

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 six permutations of the string "cab" in reverse order.

Run this code

#include <algorithm>
#include <iostream>
#include <string>
 
int main()
{
    std::string s = "cab";
 
    do
    {
        std::cout << s << ' ';
    }
    while (std::prev_permutation(s.begin(), s.end()));
 
    std::cout << s << '\n';
}

Output:

cab bca bac acb abc cba

See also

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