命名空间
变体
操作

std::rotate

来自 cppreference.cn
< cpp‎ | 算法
 
 
算法库
有约束算法与针对范围的算法 (C++20)
有约束的算法,例如 ranges::copyranges::sort 等……
执行策略 (C++17)
排序及相关操作
划分操作
排序操作
二分搜索操作
(于已划分范围上)
集合操作(于已排序范围上)
归并操作(于已排序范围上)
堆操作
最小/最大值操作
(C++11)
(C++17)
字典序比较操作
排列操作
C 库
数值操作
未初始化内存上的操作
 
定义于头文件 <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 执行。
仅当满足以下所有条件时,此重载才参与重载决议

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 // since 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 position for when “read” hits “last”
 
    for (ForwardIt read = middle; read != last; ++write, ++read)
    {
        if (write == next_read)
            next_read = read; // track where “first” went
        std::iter_swap(write, read);
    }
 
    // rotate the remaining sequence into place
    rotate(write, next_read, last);
    return write;
}

[编辑] 注意

如果 `ForwardIt` 满足 LegacyBidirectionalIterator 或(更好)LegacyRandomAccessIterator,`std::rotate` 在常见实现上具有更好的效率。

当迭代器类型满足 LegacyContiguousIterator 并且其值类型的交换不调用非平凡的特殊成员函数或通过 ADL 找到的 `swap` 时,实现(例如 MSVC STL)可能会启用向量化。

[编辑] 示例

`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("before sort:\t\t", v);
 
    // insertion sort
    for (auto i = v.begin(); i != v.end(); ++i)
        std::rotate(std::upper_bound(v.begin(), i, *i), i, i + 1);
    print("after sort:\t\t", v);
 
    // simple rotation to the left
    std::rotate(v.begin(), v.begin() + 1, v.end());
    print("simple rotate left:\t", v);
 
    // simple rotation to the right
    std::rotate(v.rbegin(), v.rbegin() + 1, v.rend());
    print("simple rotate right:\t", v);
}

输出

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

[编辑] 缺陷报告

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

缺陷报告 应用于 发布时的行为 正确的行为
LWG 488 C++98 未返回由 `first` 指向的元素的新位置。 已返回

[编辑] 另请参阅

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