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 中已移除)	`T` 如果 sizeof...(Args)==1 并且 `T` 是 `Args...` 中的第一个也是唯一的类型
`first_argument_type` (C++17 中已弃用)(C++20 中已移除)	`T1` 如果 sizeof...(Args)==2 并且 `T1` 是 `Args...` 中的两个类型中的第一个
`second_argument_type` (C++17 中已弃用)(C++20 中已移除)	`T2` 如果 sizeof...(Args)==2 并且 `T2` 是 `Args...` 中的两个类型中的第二个

[编辑] 成员函数

(构造函数)	构造一个新的 `std::function` 实例 (公共成员函数) [编辑]
(析构函数)	销毁一个 `std::function` 实例 (公有成员函数) [编辑]
operator=	赋值一个新的目标 (公有成员函数) [编辑]
swap	交换内容 (公有成员函数) [编辑]
分配 (在 C++17 中已移除)	赋值一个新的目标 (公有成员函数) [编辑]
operator bool	检查是否包含目标 (公有成员函数) [编辑]
operator()	调用目标 (公有成员函数) [编辑]
目标访问
target_type	获取存储的目标的 typeid (公有成员函数) [编辑]
target	获取指向存储的目标的指针 (公有成员函数) [编辑]

[编辑] 非成员函数

std::swap(std::function) (C++11)	专门化 std::swap 算法 (函数模板) [编辑]
operator==operator!= (在 C++20 中已移除)	将 std::function 与 nullptr 进行比较 (函数模板) [编辑]

[编辑] 辅助类

std::uses_allocator<std::function>

(C++11) (直到 C++17)

专门化 std::uses_allocator 类型特质
(类模板专门化) [编辑]

[编辑] 推导指南(自 C++17 起)

[编辑] 备注

当 `std::function` 的结果类型为引用，且从没有尾随返回类型的 lambda 表达式初始化时，应谨慎操作。由于自动推导的工作方式，此类 lambda 表达式将始终返回一个右值。因此，结果引用通常会绑定到一个临时对象，该对象的生命周期在 `std::function::operator()` 返回时结束。	(直到 C++23)
如果返回引用的 `std::function` 从返回右值的函数或函数对象 (包括没有尾随返回类型的 lambda 表达式) 初始化，则程序将格式不正确，因为禁止将返回的引用绑定到临时对象。	(自 C++23 起)

std::function<const int&()> F([] { return 42; }); // Error since C++23: can't bind
                                                  // the returned reference to a temporary
int x = F(); // Undefined behavior until C++23: the result of F() is a dangling reference
 
std::function<int&()> G([]() -> int& { static int i{0x2A}; return i; }); // OK
 
std::function<const int&()> H([i{052}] -> const int& { return i; }); // OK

[编辑] 例子

运行此代码

#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()
{
    // store a free function
    std::function<void(int)> f_display = print_num;
    f_display(-9);
 
    // store a lambda
    std::function<void()> f_display_42 = []() { print_num(42); };
    f_display_42();
 
    // store the result of a call to std::bind
    std::function<void()> f_display_31337 = std::bind(print_num, 31337);
    f_display_31337();
 
    // store a call to a member function
    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);
 
    // store a call to a data member accessor
    std::function<int(Foo const&)> f_num = &Foo::num_;
    std::cout << "num_: " << f_num(foo) << '\n';
 
    // store a call to a member function and object
    using std::placeholders::_1;
    std::function<void(int)> f_add_display2 = std::bind(&Foo::print_add, foo, _1);
    f_add_display2(2);
 
    // store a call to a member function and object ptr
    std::function<void(int)> f_add_display3 = std::bind(&Foo::print_add, &foo, _1);
    f_add_display3(3);
 
    // store a call to a function object
    std::function<void(int)> f_display_obj = PrintNum();
    f_display_obj(18);
 
    auto factorial = [](int n)
    {
        // store a lambda object to emulate "recursive lambda"; aware of extra overhead
        std::function<int(int)> fac = [&](int n) { return (n < 2) ? 1 : n * fac(n - 1); };
        // note that "auto fac = [&](int n) {...};" does not work in recursive calls
        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;

[编辑] 另请参阅

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

编译器支持
独立和托管
语言
标准库
标准库头文件
命名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用程序库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

成员函数
function::function
function::~function
function::operator=
function::swap
function::assign (直到 C++17)
function::operator bool
function::operator()
function::target_type
function::target
非成员函数
operator==operator!= (直到 C++20)
swap(std::function)
辅助类
uses_allocator<std::function> (直到 C++17)
推导指南(C++17)

cppreference.com

命名空间

变体

视图

操作