std::ranges::rotate_copy, std::ranges::rotate_copy_result

< cpp‎ | algorithm‎ | ranges
Algorithm library
Constrained algorithms and algorithms on ranges (C++20)
Constrained algorithms, e.g. ranges::copy, ranges::sort, ...
Execution policies (C++17)
Non-modifying sequence operations
Batch operations
Search operations
(C++11)                (C++11)(C++11)

Modifying sequence operations
Copy operations
Swap operations
Transformation operations
Generation operations
Removing operations
Order-changing operations
(until C++17)(C++11)
Sampling operations

Sorting and related operations
Partitioning operations
Sorting operations
Binary search operations
(on partitioned ranges)
Set operations (on sorted ranges)
Merge operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Lexicographical comparison operations
Permutation operations
C library
Numeric operations
Operations on uninitialized memory
Constrained algorithms
All names in this menu belong to namespace std::ranges
Non-modifying sequence operations
Modifying sequence operations
Partitioning operations
Sorting operations
Binary search operations (on sorted ranges)
Set operations (on sorted ranges)
Heap operations
Minimum/maximum operations
Permutation operations
Fold operations
Numeric operations
Operations on uninitialized storage
Return types
Defined in header <algorithm>
Call signature
template< std::forward_iterator I, std::sentinel_for<I> S,

          std::weakly_incrementable O >
requires std::indirectly_copyable<I, O>
constexpr rotate_copy_result<I, O>

    rotate_copy( I first, I middle, S last, O result );
(1) (since C++20)
template< ranges::forward_range R, std::weakly_incrementable O >

requires std::indirectly_copyable<ranges::iterator_t<R>, O>
constexpr rotate_copy_result<ranges::borrowed_iterator_t<R>, O>

    rotate_copy( R&& r, ranges::iterator_t<R> middle, O result );
(2) (since C++20)
Helper types
template< class I, class O >
using rotate_copy_result = in_out_result<I, O>;
(3) (since C++20)
1) Copies the elements from the source range [firstlast), to the destination range beginning at result in such a way, that the element *middle becomes the first element of the destination range and *(middle - 1) becomes the last element. The result is that the destination range contains a left rotated copy of the source range.
The behavior is undefined if either [firstmiddle) or [middlelast) is not a valid range, or the source and destination ranges overlap.
2) Same as (1), but uses r as the source range, as if using ranges::begin(r) as first and ranges::end(r) as last.

The function-like entities described on this page are niebloids, that is:

In practice, they may be implemented as function objects, or with special compiler extensions.


[edit] Parameters

first, last - the source range of elements to copy from
r - the source range of elements to copy from
middle - the iterator to the element that should appear at the beginning of the destination range
result - beginning of the destination range

[edit] Return value

{last, result + N}, where N = ranges::distance(first, last).

[edit] Complexity

Linear: exactly N assignments.

[edit] Notes

If the value type is TriviallyCopyable and the iterator types satisfy contiguous_iterator, implementations of ranges::rotate_copy usually avoid multiple assignments by using a "bulk copy" function such as std::memmove.

[edit] Possible implementation

See also the implementations in libstdc++ and MSVC STL.

struct rotate_copy_fn
    template<std::forward_iterator I, std::sentinel_for<I> S, std::weakly_incrementable O>
    requires std::indirectly_copyable<I, O>
    constexpr ranges::rotate_copy_result<I, O>
        operator()(I first, I middle, S last, O result) const
        auto c1 {ranges::copy(middle, std::move(last), std::move(result))};
        auto c2 {ranges::copy(std::move(first), std::move(middle), std::move(c1.out))};
        return {std::move(, std::move(c2.out)};
    template<ranges::forward_range R, std::weakly_incrementable O>
    requires std::indirectly_copyable<ranges::iterator_t<R>, O>
    constexpr ranges::rotate_copy_result<ranges::borrowed_iterator_t<R>, O>
        operator()(R&& r, ranges::iterator_t<R> middle, O result) const
        return (*this)(ranges::begin(r), std::move(middle),
                       ranges::end(r), std::move(result));
inline constexpr rotate_copy_fn rotate_copy {};

[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::ranges::find(src, 3);
    std::ranges::rotate_copy(src, pivot, dest.begin());
    for (int i : dest)
        std::cout << i << ' ';
    std::cout << '\n';
    // copy the rotation result directly to the std::cout
    pivot = std::ranges::find(dest, 1);
    std::ranges::rotate_copy(dest, pivot, std::ostream_iterator<int>(std::cout, " "));
    std::cout << '\n';


3 4 5 1 2
1 2 3 4 5

[edit] See also

rotates the order of elements in a range
copies a range of elements to a new location
copies and rotate a range of elements
(function template) [edit]