Namespaces
Variants

std:: function

From cppreference.net
C++
Utilities library
Function objects
Function invocation
(C++17) (C++23)
Identity function object
(C++20)
Old binders and adaptors
( until C++17* )
( until C++17* )
( until C++17* )
( until C++17* )
( until C++17* )
( until C++17* )
( until C++17* ) ( until C++17* ) ( until C++17* ) ( until C++17* )
( until C++20* )
( until C++20* )
( until C++17* ) ( until C++17* )
( until C++17* ) ( until C++17* )

( until C++17* )
( until C++17* ) ( until C++17* ) ( until C++17* ) ( until C++17* )
( until C++20* )
( until C++20* )
std::function
定义于头文件 <functional>
template < class >
class function ; /* 未定义 */
(C++11 起)
template < class R, class ... Args >
class function < R ( Args... ) > ;
(C++11 起)

类模板 std::function 是一种通用多态函数包装器。 std::function 的实例可以存储、复制及调用任何 可复制构造 的 可调用 目标 ——包括函数（通过函数指针）、 lambda表达式 、 绑定表达式 或其他函数对象，以及指向成员函数的指针和指向数据成员的指针。

存储的可调用对象被称为 std::function 的 目标 。若 std::function 不包含目标，则称其为 空 。调用 空 std::function 的 目标 将导致抛出 std::bad_function_call 异常。

std::function 满足 可复制构造 与 可复制赋值 的要求。

目录

成员类型

类型 定义
result_type R
argument_type
(C++17 中弃用) (C++20 中移除) 		当 sizeof... ( Args ) == 1 且 T 是 Args... 中第一个也是唯一的类型时
first_argument_type
(C++17 中弃用) (C++20 中移除) 		当 sizeof... ( Args ) == 2 且 T1 是 Args... 中两个类型中的第一个时
second_argument_type
(C++17 中弃用) (C++20 中移除) 		当 sizeof... ( Args ) == 2 且 T2 是 Args... 中两个类型中的第二个时

成员函数

构造新的 std::function 实例
(公开成员函数)
销毁 std::function 实例
(公开成员函数)
赋值新目标
(公开成员函数)
交换内容
(公开成员函数)
(C++17 中移除)
赋值新目标
(公开成员函数)
检查是否包含目标
(公开成员函数)
调用目标
(公开成员函数)
目标访问
获取存储目标的 typeid
(公开成员函数)
获取指向存储目标的指针
(公开成员函数)

非成员函数

(C++11)
特化 std::swap 算法
(函数模板)
(C++20 中移除)
比较 std::function 与 nullptr
(函数模板)

辅助类

(C++11) (until C++17)
特化 std::uses_allocator 类型特征
(类模板特化)

推导指引 (since C++17)

注释

当返回类型为引用的 std::function 从无尾随返回类型的 lambda 表达式初始化时需特别谨慎。由于 auto 推导机制的特性，此类 lambda 表达式始终返回纯右值。因此，生成的引用通常会绑定到一个临时对象，其生命周期在 std::function::operator() 返回时结束。

(C++23 前)

若返回引用的 std::function 从返回纯右值的函数或函数对象（包括无尾随返回类型的 lambda 表达式）初始化，则程序非良构，因为禁止将返回的引用绑定到临时对象。

(C++23 起) 
std::function<const int&()> F([] { return 42; }); // C++23 起错误：无法将返回的引用绑定到临时对象
                                                  // 
int x = F(); // C++23 前为未定义行为：F() 的返回结果是悬垂引用
std::function<int&()> G([]() -> int& { static int i{0x2A}; return i; }); // 正确
std::function<const int&()> H([i{052}] -> const int& { return i; }); // 正确

示例

运行此代码 
#include <functional>
#include <iostream>
struct Foo
{
    Foo(int num) : num_(num) {}
    void print_add(int i) const { std::cout << num_ + i << '\n'; }
    int num_;
};
void print_num(int i)
{
    std::cout << i << '\n';
}
struct PrintNum
{
    void operator()(int i) const
    {
        std::cout << i << '\n';
    }
};
int main()
{
    // 存储自由函数
    std::function<void(int)> f_display = print_num;
    f_display(-9);
    // 存储lambda表达式
    std::function<void()> f_display_42 = []() { print_num(42); };
    f_display_42();
    // 存储std::bind调用结果
    std::function<void()> f_display_31337 = std::bind(print_num, 31337);
    f_display_31337();
    // 存储成员函数调用
    std::function<void(const Foo&, int)> f_add_display = &Foo::print_add;
    const Foo foo(314159);
    f_add_display(foo, 1);
    f_add_display(314159, 1);
    // 存储数据成员访问器调用
    std::function<int(Foo const&)> f_num = &Foo::num_;
    std::cout << "num_: " << f_num(foo) << '\n';
    // 存储成员函数与对象的绑定调用
    using std::placeholders::_1;
    std::function<void(int)> f_add_display2 = std::bind(&Foo::print_add, foo, _1);
    f_add_display2(2);
    // 存储成员函数与对象指针的绑定调用
    std::function<void(int)> f_add_display3 = std::bind(&Foo::print_add, &foo, _1);
    f_add_display3(3);
    // 存储函数对象调用
    std::function<void(int)> f_display_obj = PrintNum();
    f_display_obj(18);
    auto factorial = [](int n)
    {
        // 存储lambda对象以模拟"递归lambda"；注意额外开销
        std::function<int(int)> fac = [&](int n) { return (n < 2) ? 1 : n * fac(n - 1); };
        // 注意"auto fac = [&](int n) {...}"在递归调用中无法工作
        return fac(n);
    };
    for (int i{5}; i != 8; ++i)
        std::cout << i << "! = " << factorial(i) << ";  ";
    std::cout << '\n';
}

可能的输出： 

-9
42
31337
314160
314160
num_: 314159
314161
314162
18
5! = 120;  6! = 720;  7! = 5040;

参见

(C++23)
支持给定调用签名中限定符的任何可调用对象的仅移动包装器
(类模板)
(C++26)
支持给定调用签名中限定符的任何可复制构造可调用对象的可复制包装器
(类模板)
(C++26)
任何可调用对象的非拥有包装器
(类模板)
(C++11)
调用空的 std::function 时抛出的异常
(类)
(C++11)
从成员指针创建函数对象
(函数模板)
typeid 查询类型信息，返回表示该类型的 std::type_info 对象