std::rotate_copy
<algorithm>
OutputIt rotate_copy( ForwardIt first, ForwardIt middle,
class ForwardIt1, class ForwardIt2 >
ForwardIt2 rotate_copy( ExecutionPolicy&& policy,
ForwardIt1 first, ForwardIt1 middle,
Copies the left rotation of [
first,
last)
to d_first.
[
first,
last)
, such that in the destination range beginning at d_first, the elements in [
first,
middle)
are placed after the elements in [
middle,
last)
while the orders of the elements in both ranges are preserved.std::is_execution_policy_v <std::decay_t <ExecutionPolicy>> is true.
(until C++20)std::is_execution_policy_v <std::remove_cvref_t <ExecutionPolicy>> is true.
(since C++20)If any of the following conditions is satisfied, the behavior is undefined:
-
[
first,
middle)
or[
middle,
last)
is not a valid range. - The source and destination ranges overlap.
Contents
[edit] Parameters
[
first,
last)
that should appear at the beginning of the new range
ForwardIt, ForwardIt1, ForwardIt2
must meet the requirements of LegacyForwardIterator.
OutputIt
must meet the requirements of LegacyOutputIterator.
[edit] Return value
Output iterator to the element past the last element copied.
[edit] Complexity
Exactly std::distance (first, last) assignments.
[edit] 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 and
ExecutionPolicy
is one of the standard policies, std::terminate is called. For any otherExecutionPolicy
, the behavior is implementation-defined. - If the algorithm fails to allocate memory, std::bad_alloc is thrown.
[edit] Possible implementation
See also the implementations in libstdc++, libc++, and MSVC STL.
[edit] Example
#include <algorithm> #include <iostream> #include <iterator> #include <vector> int main() { std::vector <int> src{1, 2, 3, 4, 5}; std::vector <int> dest(src.size()); auto pivot = std::find (src.begin(), src.end(), 3); std::rotate_copy(src.begin(), pivot, src.end(), dest.begin()); for (int i : dest) std::cout << i << ' '; std::cout << '\n'; // copy the rotation result directly to the std::cout pivot = std::find (dest.begin(), dest.end(), 1); std::rotate_copy(dest.begin(), pivot, dest.end(), std::ostream_iterator <int>(std::cout, " ")); std::cout << '\n'; }
Output:
3 4 5 1 2 1 2 3 4 5