std::rotate

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Algorithm library

Execution policies (C++17)
is_execution_policy	sequentialparpar_vec	sequential_execution_policyparallel_execution_policyparallel_vector_execution_policy
Non-modifying sequence operations
all_ofany_ofnone_of (C++11)(C++11)(C++11) for_each for_each_n (C++17)	countcount_if mismatch equal lexicographical_compare	findfind_iffind_if_not (C++11) find_end find_first_of	adjacent_find search search_n
Modifying sequence operations
copycopy_if (C++11) copy_n (C++11) copy_backward move (C++11) move_backward (C++11) transform	fill fill_n generate generate_n swap iter_swap swap_ranges sample (C++17)	removeremove_if replacereplace_if reverse rotate unique random_shuffle (until C++17)	remove_copyremove_copy_if replace_copyreplace_copy_if reverse_copy rotate_copy unique_copy shuffle (C++11)
Operations on uninitialized storage
uninitialized_copy	uninitialized_copy_n	uninitialized_fill	uninitialized_fill_n
Partitioning operations
is_partitioned (C++11) partition_point (C++11)	partition partition_copy (C++11)	stable_partition
Sorting operations
is_sorted (C++11) is_sorted_until (C++11)	sort stable_sort	partial_sort partial_sort_copy	nth_element
Binary search operations
lower_bound	upper_bound	binary_search	equal_range
Set operations (on sorted ranges)
merge inplace_merge	set_difference set_intersection	set_symmetric_difference set_union	includes
Heap operations
is_heap (C++11) is_heap_until (C++11)	make_heap sort_heap	push_heap pop_heap
Minimum/maximum operations
max max_element	min min_element	minmax (C++11) minmax_element (C++11)	clamp (C++17)
Permutations
is_permutation (C++11)	next_permutation	prev_permutation
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)
C library
qsort	bsearch

 

Defined in header <algorithm>
	(1)
template< class ForwardIt > void rotate( ForwardIt first, ForwardIt n_first, ForwardIt last );			(until C++11)
template< class ForwardIt > ForwardIt rotate( ForwardIt first, ForwardIt n_first, ForwardIt last );			(since C++11)
template< class ExecutionPolicy, class ForwardIt > ForwardIt rotate( ExecutionPolicy&& policy, ForwardIt first, ForwardIt n_first, ForwardIt last );		(2)	(since C++17)

1) Performs a left rotation on a range of elements.

Specifically, std::rotate swaps the elements in the range [first, last) in such a way that the element n_first becomes the first element of the new range and n_first - 1 becomes the last element.

A precondition of this function is that [first, n_first) and [n_first, last) are valid ranges.

2) Same as (1), but executed according to policy. This overload does not participate in overload resolution unless std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> is true

Parameters

first	-	the beginning of the original range
n_first	-	the element that should appear at the beginning of the rotated range
last	-	the end of the original range
policy	-	the execution policy to use. See execution policy for details.
Type requirements
- ForwardIt must meet the requirements of ValueSwappable and ForwardIterator.
- The type of dereferenced ForwardIt must meet the requirements of MoveAssignable and MoveConstructible.

Return value

(none)	(until C++11)
The iterator equal to first + (last - n_first)	(since C++11)

Complexity

Linear in the distance between first and last

Exceptions

The overload with a template parameter named ExecutionPolicy reports errors as follows:

• If execution of a function invoked as part of the algorithm throws an exception,

• if policy is std::parallel_vector_execution_policy, std::terminate is called
• if policy is std::sequential_execution_policy or std::parallel_execution_policy, the algorithm exits with an std::exception_list containing all uncaught exceptions. If there was only one uncaught exception, the algorithm may rethrow it without wrapping in std::exception_list. It is unspecified how much work the algorithm will perform before returning after the first exception was encountered.
• if policy is some other type, the behavior is implementation-defined

• If the algorithm fails to allocate memory (either for itself or to construct an std::exception_list when handling a user exception), std::bad_alloc is thrown.

Possible implementation

template <class ForwardIt> void rotate(ForwardIt first, ForwardIt n_first, ForwardIt last) { ForwardIt next = n_first; while (first != next) { std::iter_swap(first++, next++); if (next == last) { next = n_first; } else if (first == n_first) { n_first = next; } } }

Example

std::rotate is a common building block in many algorithms. This example demonstrates insertion sort:

Run this code

#include <vector>
#include <iostream>
#include <algorithm>
 
int main()
{
    std::vector<int> v{2, 4, 2, 0, 5, 10, 7, 3, 7, 1}; 
 
    std::cout << "before sort:      ";
    for (int n: v)
        std::cout << n << ' ';
    std::cout << '\n';
 
    // insertion sort
    for (auto i = v.begin(); i != v.end(); ++i) {
        std::rotate(std::upper_bound(v.begin(), i, *i), i, i+1);
    }
 
    std::cout << "after sort:       ";
    for (int n: v)
        std::cout << n << ' ';
    std::cout << '\n';
 
    // simple rotation to the left
    std::rotate(v.begin(), v.begin() + 1, v.end());
 
    std::cout << "simple rotate left  : ";
    for (int n: v)
        std::cout << n << ' ';
    std::cout << '\n';
 
    // simple rotation to the right
    std::rotate(v.rbegin(), v.rbegin() + 1, v.rend());
 
    std::cout << "simple rotate right : ";
    for (int n: v)
        std::cout << n << ' ';
    std::cout << '\n';
 
}

Output:

before sort:      2 4 2 0 5 10 7 3 7 1 
after sort:       0 1 2 2 3 4 5 7 7 10 
simple rotate left : 1 2 2 3 4 5 7 7 10 0
simple rotate right: 0 1 2 2 3 4 5 7 7 10

See also

rotate_copy	copies and rotate a range of elements (function template)
std::experimental::parallel::rotate (parallelism TS)	parallelized version of std::rotate (function template)