std::rotate

来自cppreference.com
 
C++
 
算法库
受约束算法及范围上的算法 (C++20)
包含算法例如 ranges::copy, ranges::sort, ...
执行策略 (C++17)
排序和相关操作
划分操作
排序操作
二分搜索操作（在已划分范围上）
集合操作（在有序范围上）
归并操作（在有序范围上）
堆操作
最小/最大操作
(C++11)
(C++17)
字典序比较操作
(C++20)
排列操作
C 库

数值运算
(C++11)                       
在未初始化内存上的操作
 
<tbody> </tbody>
在标头 <algorithm> 定义
template< class ForwardIt > ForwardIt rotate( ForwardIt first, ForwardIt middle, ForwardIt last );
 (1) (C++20 起为 constexpr)
template< class ExecutionPolicy, class ForwardIt > ForwardIt rotate( ExecutionPolicy&& policy, ForwardIt first, ForwardIt middle, ForwardIt last );
 (2) (C++17 起)
1) 进行元素范围上的左旋转。
具体而言，std::rotate 交换范围 [first, last) 中的元素，将 [first, middle) 中的元素放在 [middle, last) 后面并且保留这两个范围中元素的原本顺序。
2) 同 (1)，但按照 policy 执行。
此重载只有在满足以下所有条件时才会参与重载决议：
See More

std::is_execution_policy_v<std::decay_t<ExecutionPolicy>> 是 true。

(C++20 前)

std::is_execution_policy_v<std::remove_cvref_t<ExecutionPolicy>> 是 true。

(C++20 起)

如果满足以下任意条件，那么行为未定义：

(C++11 前)
(C++11 起)

参数

first, last - 要旋转的元素范围的迭代器对
middle - 应出现在旋转后范围起始的元素
policy - 所用的执行策略
类型要求
-
ForwardIt 必须满足老式向前迭代器 (LegacyForwardIterator) 。

返回值

到原先由 *first 指代的元素的迭代器，即 first 的下 std::distance(middle, last) 个迭代器。

复杂度

最多 std::distance(first, last) 次交换。

异常

拥有名为 ExecutionPolicy 的模板形参的重载按下列方式报告错误：

  • 如果作为算法一部分调用的函数的执行抛出异常，且 ExecutionPolicy 是标准策略之一，那么调用 std::terminate。对于任何其他 ExecutionPolicy，行为由实现定义。
  • 如果算法无法分配内存，那么抛出 std::bad_alloc。

可能的实现

参阅 libstdc++、libc++ 和 MSVC STL 中的实现。 

template<class ForwardIt>
constexpr // C++20 起
ForwardIt rotate(ForwardIt first, ForwardIt middle, ForwardIt last)
{
    if (first == middle)
        return last;
    
    if (middle == last)
        return first;
    
    ForwardIt write = first;
    ForwardIt next_read = first; // 当 “read” 碰到 “last” 时的读位置
    
    for (ForwardIt read = middle; read != last; ++write, ++read)
    {
        if (write == next_read)
            next_read = read; // 记录 “first” 到过的位置
        std::iter_swap(write, read);
    }
    
    // 旋转剩余序列到指定位置
    rotate(write, next_read, last);
    return write;
}

注解

在常见实现上，如果 ForwardIt 满足老式双向迭代器 (LegacyBidirectionalIterator) 或（更好的）老式随机访问迭代器 (LegacyRandomAccessIterator) ，那么 ranges::rotate 会有更高的效率。

实现（例如 MSVC STL ）可能在迭代器类型满足老式连续迭代器 (LegacyContiguousIterator) ，并且交换其值类型不调用非平凡的特殊成员函数或 ADL 所找到的 swap 时启用向量化。

示例

std::rotate 是许多算法中的公共构建块。此示例演示插入排序。

运行此代码
#include <algorithm>
#include <iostream>
#include <vector>

auto print = [](const auto remark, const auto& v)
{
    std::cout << remark;
    for (auto n : v)
        std::cout << n << ' ';
    std::cout << '\n';
};

int main()
{
    std::vector<int> v{2, 4, 2, 0, 5, 10, 7, 3, 7, 1};
    print("排序前：\t\t", v);
    
    // 插入排序
    for (auto i = v.begin(); i != v.end(); ++i)
        std::rotate(std::upper_bound(v.begin(), i, *i), i, i + 1);
    print("排序后：\t\t", v);
    
    // 简单向左旋转
    std::rotate(v.begin(), v.begin() + 1, v.end());
    print("简单向左旋转：\t", v);
    
    // 简单向右旋转
    std::rotate(v.rbegin(), v.rbegin() + 1, v.rend());
    print("简单向右旋转：\t", v);
}

输出： 

排序前：		2 4 2 0 5 10 7 3 7 1 
排序后：		0 1 2 2 3 4 5 7 7 10 
简单向左旋转：	1 2 2 3 4 5 7 7 10 0 
简单向右旋转：	0 1 2 2 3 4 5 7 7 10

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 488 C++98 没有返回 first 指向的元素的新位置 返回该位置

参阅

 复制并旋转元素范围
(函数模板) [编辑]
(C++20)
 旋转范围中的元素顺序
(算法函数对象) [编辑]