基于范围的 for
循环 (自 C++11 起)
对一个范围执行 for 循环。
用作对值范围进行操作的传统 for 循环 的更具可读性的等效项,例如容器中的所有元素。
目录 |
[编辑] 语法
attr (可选) for ( init-statement (可选) item-declaration : range-initializer ) statement |
|||||||||
attr | - | 任意数量的 属性 | ||
init-statement | - | (自 C++20 起) 以下之一
注意,任何 init-statement 必须以分号结尾。这就是为什么它通常被非正式地描述为一个表达式或一个声明,后面跟着一个分号。 | ||
item-declaration | - | 每个范围项的声明 | ||
range-initializer | - | 一个 表达式 或 花括号括起来的初始化列表 | ||
statement | - | 任何 语句 (通常是复合语句) |
[编辑] 说明
上述语法生成的代码等效于以下代码 除了 range-initializer 的临时对象的生存期扩展 (参见 下文)(自 C++23 起) (用 /* */ 包裹的变量和表达式仅用于说明)
|
(截至 C++17) |
|
(自 C++17 起) (截至 C++20) |
|
(自 C++20 起) |
range-initializer 被求值以初始化要迭代的序列或范围。序列中的每个元素依次被解引用,并用于初始化具有 item-declaration 中给定类型和名称的变量。
item-declaration 可以是以下之一
仅用于说明的表达式 /* begin-expr */ 和 /* end-expr */ 的定义如下
- 如果 /* range */ 的类型是对数组类型
R
的引用
- 如果
R
的界限为 N,则 /* begin-expr */ 为 /* range */ 且 /* end-expr */ 为 /* range */ + N。 - 如果
R
是一个未知界限的数组或一个不完整类型的数组,则程序是非良构的。
- 如果
- 如果 /* range */ 的类型是对类类型
C
的引用,并且在C
的作用域内搜索名称 “begin
” 和 “end
” 时,每个名称都至少找到一个声明,则 /* begin-expr */ 为 /* range */.begin() 且 /* end-expr */ 为 /* range */.end()。 - 否则,/* begin-expr */ 为 begin(/* range */) 且 /* end-expr */ 为 end(/* range */),其中 “
begin
” 和 “end
” 是通过 依赖于参数的查找 找到的 (不执行非 ADL 查找)。
如果需要在 statement 内终止循环,则可以使用 break 语句 作为终止语句。
如果需要在 statement 内终止当前迭代,则可以使用 continue 语句 作为快捷方式。
如果在 init-statement 中引入的名称在 statement 的最外层块中被重新声明,则程序是非良构的
for (int i : {1, 2, 3}) int i = 1; // error: redeclaration
[编辑] 临时范围初始化器
如果 range-initializer 返回一个临时对象,则其生存期将延长至循环结束,如绑定到转发引用 /* range */ 所示。
范围初始化器 中所有临时对象的生命周期都不会延长,除非它们会在 范围初始化器 结束时被销毁(自 C++23 起)。
// if foo() returns by value for (auto& x : foo().items()) { /* ... */ } // until C++23 undefined behavior
可以使用 初始化语句 来解决此问题。 for (T thing = foo(); auto& x : thing.items()) { /* ... */ } // OK |
(自 C++20 起) |
请注意,即使在 C++23 中,中间函数调用的非引用参数也不会获得生命周期延长(因为在某些 ABI 中,它们是在被调用方而不是调用方中销毁的),但这仅对本身就有问题的函数才会造成问题。 using T = std::list<int>; const T& f1(const T& t) { return t; } const T& f2(T t) { return t; } // always returns a dangling reference T g(); void foo() { for (auto e : f1(g())) {} // OK: lifetime of return value of g() extended for (auto e : f2(g())) {} // UB: lifetime of f2's value parameter ends early } |
(自 C++23 起) |
[编辑] 注释
如果 范围初始化器 是一个 花括号括起来的初始化列表,则 /* 范围 */ 会被推导为对 std::initializer_list 的引用。
在泛型代码中,使用推导到转发引用是安全的,而且实际上是更可取的,例如 for (auto&& var : sequence)。
如果范围类型具有名为“begin
”和名为“end
”的成员,则会使用成员解释。无论成员是类型、数据成员、函数还是枚举器,也无论其可访问性如何,都会执行此操作。因此,即使存在命名空间范围的“begin
”/“end
”函数,也不能将像 class meow { enum { begin = 1, end = 2 }; /* 类的其余部分 */ }; 这样的类与基于范围的 for 循环一起使用。
虽然在 项声明 中声明的变量通常在 语句 中使用,但这样做不是必需的。
从 C++17 开始,/* begin-expr */ 和 /* end-expr */ 的类型不必相同,实际上 /* end-expr */ 的类型不必是迭代器:它只需要能够与迭代器进行不等式比较即可。这使得可以通过谓词来界定范围(例如“迭代器指向空字符”)。 |
(自 C++17 起) |
当与具有写时复制语义的(非常量)对象一起使用时,基于范围的 for 循环可能会通过(隐式)调用非常量 begin()
成员函数来触发深度复制。
如果这是不希望的(例如,因为循环实际上没有修改对象),则可以使用 std::as_const 来避免这种情况。 struct cow_string { /* ... */ }; // a copy-on-write string cow_string str = /* ... */; // for (auto x : str) { /* ... */ } // may cause deep copy for (auto x : std::as_const(str)) { /* ... */ } |
(自 C++17 起) |
功能测试宏 | 值 | 标准 | 功能 |
---|---|---|---|
__cpp_range_based_for |
200907L | (C++11) | 基于范围的 for 循环 |
201603L | (C++17) | 具有 不同 begin /end 类型的基于范围的 for 循环 | |
202211L | (C++23) | 范围初始化器 中所有临时对象的生命周期延长 |
[编辑] 关键字
[编辑] 示例
#include <iostream> #include <vector> int main() { std::vector<int> v = {0, 1, 2, 3, 4, 5}; for (const int& i : v) // access by const reference std::cout << i << ' '; std::cout << '\n'; for (auto i : v) // access by value, the type of i is int std::cout << i << ' '; std::cout << '\n'; for (auto&& i : v) // access by forwarding reference, the type of i is int& std::cout << i << ' '; std::cout << '\n'; const auto& cv = v; for (auto&& i : cv) // access by f-d reference, the type of i is const int& std::cout << i << ' '; std::cout << '\n'; for (int n : {0, 1, 2, 3, 4, 5}) // the initializer may be a // braced-enclosed initializer list std::cout << n << ' '; std::cout << '\n'; int a[] = {0, 1, 2, 3, 4, 5}; for (int n : a) // the initializer may be an array std::cout << n << ' '; std::cout << '\n'; for ([[maybe_unused]] int n : a) std::cout << 1 << ' '; // the loop variable need not be used std::cout << '\n'; for (auto n = v.size(); auto i : v) // the init-statement (C++20) std::cout << --n + i << ' '; std::cout << '\n'; for (typedef decltype(v)::value_type elem_t; elem_t i : v) // typedef declaration as init-statement (C++20) std::cout << i << ' '; std::cout << '\n'; for (using elem_t = decltype(v)::value_type; elem_t i : v) // alias declaration as init-statement (C++23) std::cout << i << ' '; std::cout << '\n'; }
输出
0 1 2 3 4 5 0 1 2 3 4 5 0 1 2 3 4 5 0 1 2 3 4 5 0 1 2 3 4 5 0 1 2 3 4 5 1 1 1 1 1 1 5 5 5 5 5 5 0 1 2 3 4 5 0 1 2 3 4 5
[编辑] 缺陷报告
以下行为更改缺陷报告已追溯应用于先前发布的 C++ 标准。
DR | 应用于 | 发布时的行为 | 正确行为 |
---|---|---|---|
CWG 1442 | C++11 | 未指定非成员 “ begin ”和“end ”的查找是否包括通常的非限定查找 |
没有通常的非限定查找 |
CWG 2220 | C++11 | 初始化语句 中引入的名称可以重新声明 | 在这种情况下,程序格式错误 |
CWG 2825 | C++11 | 如果 范围初始化器 是花括号括起来的初始化列表, 则将查找非成员“ begin ”和“end ” |
在这种情况下将查找成员“begin ”和“ end ” |
P0962R1 | C++11 | 如果存在成员 “ begin ”和“end ”中的任何一个,则使用成员解释 |
仅当两者都存在时才使用 |
[编辑] 另请参见
将函数应用于一系列元素 (函数模板) |