namespace std::ranges {
  template <forward_iterator I,
            sentinel_for<I> S,
            weakly_incrementable O>
    requires indirectly_copyable<I, O>
  constexpr rotate_copy_result<I, O>
    rotate_copy(I first,
                I middle,
                S last,
                O result); // (1) C++20

  template <forward_range R,
            weakly_incrementable O>
    requires indirectly_copyable<iterator_t<R>, O>
  constexpr rotate_copy_result<borrowed_iterator_t<R>, O>
    rotate_copy(R&& r,
                iterator_t<R> middle,
                O result); // (2) C++20

  template <execution-policy Ep,
            random_access_iterator I,
            sized_sentinel_for<I> S,
            random_access_iterator O,
            sized_sentinel_for<O> OutS>
    requires indirectly_copyable<I, O>
  rotate_copy_truncated_result<I, O>
    rotate_copy(Ep&& exec,
                I first,
                I middle,
                S last,
                O result,
                OutS result_last); // (3) C++26

  template <execution-policy Ep,
            sized-random-access-range R,
            sized-random-access-range OutR>
    requires indirectly_copyable<iterator_t<R>, iterator_t<OutR>>
  rotate_copy_truncated_result<borrowed_iterator_t<R>, borrowed_iterator_t<OutR>>
    rotate_copy(Ep&& exec,
                R&& r,
                iterator_t<R> middle,
                OutR&& result_r); // (4) C++26
}

概要

middleの要素が先頭、middle-1の要素が末尾となるように、[first,last)の要素の並びを回転させ、その結果を出力の範囲へコピーする。

• (1): イテレータ範囲を指定する
• (2): Rangeを直接指定する
• (3): (1)の並列アルゴリズム版。実行ポリシーを指定し、出力範囲の終端も指定する
• (4): (2)の並列アルゴリズム版。実行ポリシーを指定する

事前条件

[first,last) と [result,result + (last - first)) の範囲は重なっていてはならない。

効果

• (1) : 0 以上 last - first 未満の整数 i について、*(result + i) = *(first + (i + (middle - first)) % (last - first)) という操作によって [first,last) の範囲を [result,result + (last - first)) の範囲へコピーする。
• (2) : 以下と等価：
  

  return ranges::rotate_copy(ranges::begin(r), middle, ranges::end(r), std::move(result));
  

• (3) : (1)と同じ効果を、指定された実行ポリシーexecに従って実行する。
• (4) : 以下と等価：
  

  return ranges::rotate_copy(std::forward<Ep>(exec), ranges::begin(r), middle,
                             ranges::begin(r) + ranges::distance(r),
                             ranges::begin(result_r),
                             ranges::begin(result_r) + ranges::distance(result_r));
  

戻り値

• (1), (2): { .in = last, .out = result + (last - first) }
• (3), (4): 出力範囲が入力範囲より短い場合、出力範囲の末尾まで書き込み、in1とin2で入力範囲のどこまで処理されたかを示す。in1は[middle, last)の範囲内の停止点、in2は[first, middle)の範囲内の停止点を指す。出力範囲が十分な場合はin1 == lastかつin2 == middleとなる

計算量

正確に last - first 回代入する。

例

基本的な使い方

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

int main() {
  std::string str = "rotate";
  std::string result;

  std::ranges::rotate_copy(str, str.begin() + 2, std::back_inserter(result));

  std::cout << result << std::endl;
}

出力

tatero

並列アルゴリズムの例 (C++26)

#include <algorithm>
#include <iostream>
#include <vector>
#include <execution>

int main() {
  std::vector<int> src = {1, 2, 3, 4, 5};
  std::vector<int> dst(src.size());

  // 並列に回転コピーする（3番目の要素が先頭になるように）
  auto result = std::ranges::rotate_copy(
    std::execution::par, src, src.begin() + 2, dst);

  for (int x : dst) {
    std::cout << x << ' ';
  }
  std::cout << std::endl;
}

出力

3 4 5 1 2

バージョン

言語

• C++20

処理系

• Clang: ??
• GCC: 10.1.0 ✅
• Visual C++: 2019 Update 10 ✅

参照

• N4861 25 Algorithms library
• P3179R9 C++ parallel range algorithms
• P3709R2 Reconsider parallel ranges::rotate_copy and ranges::reverse_copy
• LWG Issue 3759. ranges::rotate_copy should use std::move
  • C++23で、範囲版がイテレータ版へresultを渡す際、resultがweakly_incrementableのみでコピー不可の可能性があるためstd::move(result)で渡すよう修正された
• LWG Issue 4441. ranges::rotate do not handle sized-but-not-sized-sentinel ranges correctly
  • C++26で、実行ポリシーをとる範囲版の効果を規定する等価コードで、末尾イテレータの算出がranges::end(r)からranges::begin(r) + ranges::distance(r)へ変更された。サイズは判るがsized sentinelを持たない範囲を正しく扱うため