构造闭包):能够捕获作用域中的变量的无名函数对象。
语法
[ 捕获 ] <模板形参>(可选)(C++20) ( 形参 ) 说明符(可选) 异常说明 attr -> ret requires(可选)(C++20) { 函数体 } | (1) | |
[ 捕获 ] ( 形参 ) -> ret { 函数体 } | (2) | |
[ 捕获 ] ( 形参 ) { 函数体 } | (3) | |
[ 捕获 ] { 函数体 } | (4) | |
1) 完整声明。
2) const lambda 的声明:复制捕获的对象在 lambda 体内为 const。
3) 省略尾随返回类型:闭包的 operator()
的返回类型从 return 语句推导,如同对于声明返回类型为 auto 的函数的推导一样。
4) 省略形参列表:不接收实参的函数,如同形参列表是 ()
。仅当 constexpr
、mutable
、异常说明、属性或尾随返回类型全都不使用时才能使用此形式。
解释
捕获 | - | 零或更多捕获符的逗号分隔列表,可选地以 默认捕获符(capture-default) 起始。 有关捕获符的详细描述,见下文。 若变量满足下列条件,则 lambda 表达式可以不捕获就使用它 - 该变量为非局部变量,或具有静态或线程局部存储期(该情况下无法捕获该变量),或者 - 该变量为以常量表达式初始化的引用。 若变量满足下列条件,则 lambda 表达式可以不捕获就读取其值 - 该变量具有 const 而非 volatile 的整型或枚举类型,并已用常量表达式初始化,或者 - 该变量为 constexpr 且无 mutable 成员。 | ||||
<模板形参>(C++20) | - | (角括号中的)模板形参列表,用于为泛型 lambda 提供各模板形参的名字(见下文的 ClosureType::operator() )。与在模板声明中相似,模板形参列表可以后附可选的 requires 子句,它指定各模板实参上的制约。若提供,则模板形参列表不能为空(不允许 <> )。 | ||||
形参 | - | 形参列表,如在具名函数中,但不允许默认实参 (C++14 前)。当以 auto 为形参类型时,该 lambda 为泛型 lambda。 (C++14 起) | ||||
说明符 | - | 可选的说明符的序列。允许下列说明符: - mutable :允许 函数体 修改各个复制捕获的对象,以及调用其非 const 成员函数
| ||||
异常说明 | - | 为闭包类型的 operator() 提供异常说明或 noexcept 子句 | ||||
attr | - | 为闭包类型的函数调用运算符的类型提供属性说明。这样指定的任何属性均属于函数调用运算符的类型,而非函数调用运算符自身。(例如不能使用 [[noreturn]] | ||||
ret | - | 返回类型。若缺失,则由函数的 return 语句所蕴含(或当函数不返回任何值时为 void) | ||||
requires | - | 向闭包类型的 operator() 添加制约 | ||||
函数体 | - | 函数体 |
Lambda 表达式是纯右值表达式,其类型是独有的无名非联合非聚合类类型,被称为闭包类型(closure type),它(对于 ADL 而言)声明于含有该 lambda 表达式的最小块作用域、类作用域或命名空间作用域。闭包类型有下列成员:
ClosureType::operator()(形参)
ret operator()(形参) const { 函数体 } | (未使用关键词 mutable) | |
ret operator()(形参) { 函数体 } | (使用了关键词 mutable) | |
template<模板形参>ret operator()(形参) const { 函数体 } | (C++14 起) (泛型 lambda) | |
template<模板形参>ret operator()(形参) { 函数体 } | (C++14 起) (泛型 lambda,使用了关键词 mutable) | |
当被调用时,执行 lambda 表达式的函数体。当访问变量时,访问的是其被捕获的副本(对于以复制捕获的实体)或原对象(对于以引用捕获的实体)。除非 lambda 表达式中使用了关键词 mutable,否则函数调用表达式被 const 限定,且以复制捕获的对象从这个 operator() 的内部不可修改。函数调用运算符始终不被 volatile 限定且始终非虚。
若函数调用运算符满足针对 constexpr 函数的要求,则它始终是 constexpr。若关键词 constexpr 用于 lambda 声明,则它亦为 constexpr。 | (C++17 起) |
若在 lambda 表达式中使用关键词 consteval ,则函数调用运算符是立即函数。 | (C++20 起) |
对于 形参 中每个类型指定为 auto 的参数,以其出现顺序向 模板形参 中添加一个虚设的模板形参。当虚设的模板形参所对应的 形参 中的函数形参是函数形参包时,它可为形参包。
ClosureType 的 operator() 不能被显式实例化或显式特化。 | (C++14 起) |
若 lambda 定义使用显式的模板形参列表,则该模板形参列表用于 operator() 。对于 形参 中每个类型指定为 auto 的形参,都向模板形参列表尾部追加一个额外的虚设模板形参:
| (C++20 起) |
Lambda 表达式上的异常说明 异常说明 应用于函数调用运算符或运算符模板。
对于名字查找,确定 this 指针的类型和值,以及对于访问非静态类成员而言,闭包类型的函数调用运算符的函数体被认为处于 lambda 表达式的语境中。
- struct X {
- int x, y;
- int operator()(int);
- void f()
- {
- // 下列 lambda 的语境是成员函数 X::f
- [=]()->int
- {
- return operator()(this->x + y); // X::operator()(this->x + (*this).y)
- // 拥有类型 X*
- };
- }
- };
ClosureType
的 operator()
不能在友元声明中指名。
悬垂引用
若以引用隐式或显式捕获非引用实体,而在该实体的生存期结束之后调用闭包对象的函数调用运算符,则发生未定义行为。C++ 的闭包并不延长被捕获的引用的生存期。
这同样适用于被捕获的 this
指针所指向的对象的生存期。
ClosureType::operator ret(*)(形参)()
无捕获的非泛型 lambda | ||
using F = ret()(形参);operator F() const; | (C++17 前) | |
using F = ret()(形参);constexpr operator F() const; | (C++17 起) | |
无捕获的泛型 lambda | ||
template<模板形参> using fptr_t = /见下文/;template<模板形参> operator fptr_t<模板形参>() const; | (C++14 起) (C++17 前) | |
template<模板形参> using fptr_t = /见下文/;template<模板形参> constexpr operator fptr_t<模板形参>() const; | (C++17 起) | |
仅当 lambda 表达式的捕获符列表为空时才定义这个用户定义转换函数。它是闭包对象的公开、constexpr、 (C++17 起)非虚、非 explicit、const noexcept (C++14 起) 成员函数。若 lambda 的函数调用运算符是立即函数,则转换函数亦为立即函数。 (C++20 起)
泛型无捕获 lambda 拥有一个用户定义的转换函数模板,它具有与函数调用运算符模板相同的虚设模板形参列表。若其返回类型为空或 auto,则由函数模板特化上的返回类型推导获得,而它则以转换函数模板的模板实参推导获得。 | (C++14 起) |
这个转换函数所返回的值,是指向一个具有 C++ 语言连接的函数,而调用该函数时,效果与直接调用闭包对象的函数调用运算符相同。
若函数调用运算符(或对于泛型 lambda 为其特化)为 constexpr,则此函数为 constexpr。 若闭包对象的 operator() 具有无抛出异常说明,则此函数返回的指针具有指向 noexcept 函数的指针类型。 | (C++17 起) |
若函数调用运算符(或对于泛型 lambda 为其特化)是立即函数,则此函数是立即函数。 | (C++20 起) |
ClosureType::ClosureType()
ClosureType() = delete; | (C++14 前) | |
ClosureType() = default; | (C++20 起)(仅当未指定任何捕获时) | |
ClosureType(const ClosureType& ) = default; | (C++14 起) | |
ClosureType(ClosureType&& ) = default; | (C++14 起) | |
闭包类型非可默认构造 (DefaultConstructible) 。闭包类型带有被弃置的 (C++14 前)没有 (C++14 起)默认构造函数。 | (C++20 前) |
若未指定 捕获,则闭包类型拥有预置的默认构造函数。否则,它没有默认构造函数(这包含有 默认捕获符(capture-default) 的情况,即使实际上它不捕获任何变量也是如此)。 | (C++20 起) |
复制构造函数与移动构造函数被隐式声明 (C++14 前)声明为预置的 (C++14 起),并按照复制构造函数与移动构造函数的通常规则隐式定义。
ClosureType::operator=(const ClosureType&)
ClosureType& operator=(const ClosureType&) = delete; | (C++20 前) | |
ClosureType& operator=(const ClosureType&) = default;ClosureType& operator=(ClosureType&&) = default; | (C++20 起) (仅当未指定任何捕获时) | |
ClosureType& operator=(const ClosureType&) = delete; | (C++20 起) (其他情况) | |
复制赋值运算符被定义为弃置的(且未声明移动赋值运算符)。闭包类型非可复制赋值 (CopyAssignable) 。 | (C++20 前) |
若不指定 捕获,则闭包类型拥有预置的复制赋值运算符和预置的移动赋值运算符。否则,它拥有弃置的复制赋值运算符(这包含有 默认捕获符 的情况,即使实际上它不捕获任何变量也是如此)。 | (C++20 起) |
ClosureType::~ClosureType()
~ClosureType() = default; | ||
析构函数是隐式声明的。
ClosureType::Captures
T1 a; T2 b; … | ||
若 lambda 表达式以复制(隐式地以捕获子句 [=]
或显式地以不含字符 & 的捕获符,例如 [a, b, c]
)捕获了任何内容,则闭包类型包含保有所有被如此捕获的实体的副本的无名非静态数据成员,它们以未指明的顺序声明。
对应于无初始化器的捕获符的数据成员,在求值 lambda 表达式时被直接初始化。对应于带有初始化器的捕获符的,则按其初始化器的要求初始化(可为复制或直接初始化)。若捕获了数组,则各数组元素以下标递增顺序直接初始化。初始化各数据成员所用的顺序是它们的声明顺序(它是未指明的)。
每个数据成员的类型是其对应被捕获实体的类型,除非实体拥有引用类型(该情况下,到函数的引用被捕获为到被引用函数的左值引用,而到对象的引用被捕获为被引用对象的副本)。
对于以引用捕获(以默认捕获符 [&]
或使用了字符 &,例如 [&a, &b, &c]
)的实体,闭包类型中是否声明额外的数据成员是未指明的,但任何这种附加成员必须满足字面类型 (LiteralType) (C++17 起)。
不允许在不求值表达式、模板实参、别名声明、typedef 声明,以及函数(或函数模板)声明中除了函数体和函数的默认实参以外的任何位置中出现 lambda 表达式。 | (C++20 前) |
Lambda 捕获
捕获 是零或更多捕获符的逗号分隔列表,可选地以 默认捕获符 开始。仅有的默认捕获符是
&
(以引用隐式捕获被使用的自动变量)和=
(以复制隐式捕获被使用的自动变量)。
当出现任一默认捕获符时,都能隐式捕获当前对象(this
)。当它被隐式捕获时,始终被以引用捕获,即使默认捕获符是 =
也是如此。当默认捕获符为 =
时,this
的隐式捕获被弃用。 (C++20 起)
捕获 中单独的捕获符的语法是
标识符 | (1) | |
标识符 … | (2) | |
标识符 初始化器 | (3) | (C++14 起) |
& 标识符 | (4) | |
& 标识符 … | (5) | |
& 标识符 初始化器 | (6) | (C++14 起) |
this | (7) | |
* this | (8) | (C++17 起) |
… 标识符 初始化器 | (9) | (C++20 起) |
& … 标识符 初始化器 | (10) | (C++20 起) |
1) 简单以复制捕获
2) 作为包展开的简单以复制捕获
3) 带初始化器的以复制捕获
4) 简单以引用捕获
5) 作为包展开的简单引用捕获
6) 带初始化器的以引用捕获
7) 当前对象的简单以引用捕获
8) 当前对象的简单以复制捕获
9) 用作为包展开的初始化器以复制捕获
10) 用作为包展开的初始化器以引用捕获
当默认捕获符是 &
时,后继的简单捕获符必须不以 &
开始。
- struct S2 { void f(int i); };
- void S2::f(int i)
- {
- [&]{}; // OK:默认以引用捕获
- [&, i]{}; // OK:以引用捕获,但 i 以值捕获
- [&, &i] {}; // 错误:以引用捕获为默认时的以引用捕获
- [&, this] {}; // OK:等价于 [&]
- [&, this, i]{}; // OK:等价于 [&, i]
- }
当默认捕获符是 =
时,后继的简单捕获符必须以 &
开始,或者为 *this
(C++17 起) 或 this
(C++20 起)。
- struct S2 { void f(int i); };
- void S2::f(int i)
- {
- [=]{}; // OK:默认以复制捕获
- [=, &i]{}; // OK:以复制捕获,但 i 以引用捕获
- [=, *this]{}; // C++17 前:错误:无效语法
- // C++17 起:OK:以复制捕获外围的 S2
- [=, this] {}; // C++20 前:错误:= 为默认时的 this
- // C++20 起:OK:同 [=]
- }
任何捕获符只可以出现一次:
- struct S2 { void f(int i); };
- void S2::f(int i)
- {
- [i, i] {}; // 错误:i 重复
- [this, *this] {}; // 错误:"this" 重复 (C++17)
- }
只有定义于块作用域或默认成员初始化器中的 lambda 表达式能拥有默认捕获符或无初始化器的捕获符。对于这种 lambda 表达式,其可达作用域(reaching scope)定义为直至并包含其最内层的外围函数(及其形参)的外围作用域的集合。这其中包含各个嵌套的块作用域,以及当此 lambda 为嵌套的 lambda 时也包含其各个外围 lambda 的作用域。
(除了 this
捕获符之外的)任何无初始化器的捕获符中的 标识符,使用通常的无限定名字查找在 lambda 的可达作用域中查找。查找结果必须是声明于可达作用域中的,具有自动存储期的变量。该变量(或 this
)被显式捕获。
带有初始化器的捕获符,其行为如同它声明并显示捕获一个以类型 auto 声明的变量,该变量的声明区是 lambda 表达式体(即它不在其初始化器的作用域中),但: - 若以复制捕获,则闭包对象的非静态数据成员是指代这个 auto 变量的另一种方式。 - 若以引用捕获,则引用变量的生存期在闭包对象的生存期结束时结束。 这可用于以如 x = std::move(x) 这样的捕获符捕获仅可移动的类型。 这亦使得以 const 引用进行捕获称为可能,比如以 &cr = std::as_const(x) 或类似的方式。
| (C++14 起) |
若捕获符列表具有默认捕获符,且未显式(以 this
或 *this
)捕获其外围对象,或捕获任何自动变量,则以下情况下,它隐式捕获之
- lambda 体 ODR 式使用了变量或
this
指针
- 或者,变量或 this 在取决于某个泛型 lambda 形参的 (C++17 前)表达式内的潜在求值表达式中被指名(包括在使用非静态类成员的前添加隐含的 this-> )。就此而言,始终认为 typeid 的操作数被潜在求值。即使仅在弃用语句中指名实体,也可能会隐式捕获它。 (C++17 起)
| (C++14 起) |
若 lambda 体 ODR 式使用了以复制捕获的实体,则它访问的是闭包类型的成员。若它未 ODR 式使用该实体,则访问是到原对象的:
- void f(const int*);
- void g()
- {
- const int N = 10;
- [=]{
- int arr[N]; // 非 ODR 式使用:指代 g 的 const int N
- f(&N); // ODR 式使用:导致 N 被(以复制)捕获
- // &N 是闭包对象的成员 N 的地址,而非 g 中的 N
- }();
- }
若 lambda ODR 式使用了以引用捕获的引用,则它使用原引用所指代的对象,而非被捕获的引用自身:
运行此代码
- #include <iostream>
- auto make_function(int& x) {
- return [&]{ std::cout << x << '\n'; };
- }
- int main() {
- int i = 3;
- auto f = make_function(i); // f 中对 x 的使用直接绑定到 i
- i = 5;
- f(); // OK;打印 5
- }
在 lambda 体内,在任何具有自动存储期的变量上使用的任何 decltype,都如同将它捕获并 ODR 式使用,尽管 decltype 自身不是 ODR 式使用且不实际发生捕获:
- void f3() {
- float x, &r = x;
- [=]
- { // x 与 r 不被捕获(出现于 decltype 的操作数中并不是 ODR 式使用)
- decltype(x) y1; // y1 拥有 float 类型
- decltype((x)) y2 = y1; // y2 拥有 float const& 类型,因为此 lambda
- // 非 mutable 且 x 是左值
- decltype(r) r1 = y1; // r1 拥有 float& 类型(不考虑变换)
- decltype((r)) r2 = y2; // r2 拥有 float const& 类型
- };
- }
Lambda 所(隐式或显示)捕获的任何实体均被该 lambda 表达式所 ODR 式使用(因此,嵌套的 lambda 的隐式捕获将触发其外围 lambda 的隐式捕获)。
所有隐式捕获的变量必须声明于 lambda 的可达作用域中。
若 lambda (以 this
或 *this
)捕获了其外围对象,则要么其最接近的外围函数必须是非静态成员函数,要么该 lambda 必须处于某个默认成员初始化器中:
- struct s2 {
- double ohseven = .007;
- auto f() { // 以下两个 lambda 的最接近外围函数
- return [this] { // 以引用捕获外围的 s2
- return [*this] { // 以复制捕获外围的 s2 (C++17)
- return ohseven; // OK
- }
- }();
- }
- auto g() {
- return []{ // 无捕获
- return [*this]{}; // 错误:*this 未被外层 lambda 表达式所捕获
- }();
- }
- };
若 lambda 表达式(或泛型 lambda 的函数调用运算符的一个实例化)ODR 式使用了 this
或任何具有自动存储期的变量,则它必须被该 lambda 表达式所捕获。
- void f1(int i)
- {
- int const N = 20;
- auto m1 = [=] {
- int const M = 30;
- auto m2 = [i] {
- int x[N][M]; // N 与 M 未被 ODR 式使用
- // (它们未被捕获是 OK 的)
- x[0][0] = i; // i 被 m2 显式捕获
- // 并被 m1 隐式捕获
- };
- };
- struct s1 // f1() 中的局部类
- {
- int f;
- void work(int n) // 非静态成员函数
- {
- int m = n * n;
- int j = 40;
- auto m3 = [this, m] {
- auto m4 = [&, j] { // 错误:j 未被 m3 所捕获
- int x = n; // 错误:n 被 m4 隐式捕获
- // 但未被 m3 所捕获
- x += m; // ok:m 被 m4 捕获
- // 且为 m3 显式捕获
- x += i; // 错误:i 在可达作用域之外
- // (该作用域终于 work())
- x += f; // ok:this 被 m4 隐式捕获
- // 且被 m3 显式捕获
- };
- };
- }
- };
- }
以不带有初始化器的捕获符不能捕获类成员(如上提及,捕获符列表中仅容许变量):
- class S {
- int x = 0;
- void f() {
- int i = 0;
- // auto l1 = [i, x]{ use(i, x); }; // 错误:x 非变量
- auto l2 = [i, x=x]{ use(i, x); }; // OK,复制捕获
- i = 1; x = 1; l2(); // 调用 use(0,0)
- auto l3 = [i, &x=x]{ use(i, x); }; // OK,引用捕获
- i = 2; x = 2; l3(); // 调用 use(1,2)
- }
- };
当 lambda 用隐式的以复制捕获捕获某个成员时,它并不产生该成员变量的副本:对成员变量 m
的使用被处理成表达式 (this).m,而 this 始终被隐式以引用捕获:
- class S {
- int x = 0;
- void f() {
- int i = 0;
- auto l1 = [=]{ use(i, x); }; // 捕获 i 的副本和 this 指针的副本
- i = 1; x = 1; l1(); // 调用 use(0,1),如同 i 以复制而 x 以引用捕获
- auto l2 = [i, this]{ use(i, x); }; // 同上,令之为显式捕获
- i = 2; x = 2; l2(); // 调用 use(1,2),如同 i 以复制而 x 以引用捕获
- auto l3 = [&]{ use(i, x); }; // 以引用捕获 i,并捕获 this 指针的副本
- i = 3; x = 2; l3(); // 调用 use(3,2),如同 i 与 x 均以引用捕获
- auto l4 = [i, *this]{ use(i, x); }; // 制造 *this 的副本,包含 x 的副本
- i = 4; x = 4; l4(); // 调用 use(3,2),如同 i 与 x 均以复制捕获
- }
- };
若 lambda 表达式出现于默认实参中,则它不能显式或隐式捕获任何变量。
不能捕获匿名联合体的成员。
若嵌套的 lambda m2
捕获了也被其直接外围 lambda m1
所捕获的实体,则以如下方式将 m2
的捕获进行变换:
- 若外围 lambda
m1
以复制捕获,则m2
捕获m1
的闭包类型的非静态成员,而非原变量或this
。 - 若外围 lambda
m1
以引用捕获,则m2
捕获原变量或this
。
运行此代码
- #include <iostream>
- int main()
- {
- int a = 1, b = 1, c = 1;
- auto m1 = [a, &b, &c]() mutable {
- auto m2 = [a, b, &c]() mutable {
- std::cout << a << b << c << '\n';
- a = 4; b = 4; c = 4;
- };
- a = 3; b = 3; c = 3;
- m2();
- };
- a = 2; b = 2; c = 2;
- m1(); // 调用 m2() 并打印 123
- std::cout << a << b << c << '\n'; // 打印 234
- }
示例
此示例演示如何传递 lambda 给泛型算法,以及 lambda 表达式所产生的对象能如何存储于 std::function 对象。
运行此代码
- #include <vector>
- #include <iostream>
- #include <algorithm>
- #include <functional>
- int main()
- {
- std::vector<int> c = {1, 2, 3, 4, 5, 6, 7};
- int x = 5;
- c.erase(std::remove_if(c.begin(), c.end(), [x](int n) { return n < x; }), c.end());
- std::cout << "c: ";
- std::for_each(c.begin(), c.end(), [](int i){ std::cout << i << ' '; });
- std::cout << '\n';
- // 闭包的类型不能被指名,但可用 auto 提及
- // C++14 起,lambda 能拥有自身的默认实参
- auto func1 = [](int i = 6) { return i + 4; };
- std::cout << "func1: " << func1() << '\n';
- // 与所有可调用对象相同,闭包能可以被捕获到 std::function 之中
- // (这可能带来不必要的开销)
- std::function<int(int)> func2 = [](int i) { return i + 4; };
- std::cout << "func2: " << func2(6) << '\n';
- }
输出:
- c: 5 6 7
- func1: 10
- func2: 10
缺陷报告
下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。
DR | 应用于 | 出版时的行为 | 正确行为 |
---|---|---|---|
CWG 975 | C++11 | 仅当 lambda 体含有单条 return 语句时才推导闭包的 operator() 的返回类型 | 如同对于 C++14 返回 auto 的函数一般推导 |
CWG 1891 | C++14 | 闭包带有弃置的默认构造函数和隐含的复制/移动构造函数 | 无默认及预置的复制/移动 |
CWG 1722 | C++14 | 无捕获 lambda 的转换函数有未指明的异常说明 | 转换函数为 noexcept |