std::function
来自cppreference.com
< cpp | utility | functional
| 在标头 <functional> 定义
|
||
| template< class > class function; /* 未定义 */ |
(C++11 起) | |
| template< class R, class... Args > class function<R(Args...)>; |
(C++11 起) | |
类模板 std::function 是通用多态函数包装器。 std::function 的实例能存储、复制及调用任何可复制构造 (CopyConstructible) 的可调用 (Callable) 目标——函数（通过其指针）、 lambda 表达式、 bind 表达式或其他函数对象，还有指向成员函数指针和指向数据成员指针。
存储的可调用对象被称为 std::function 的目标。若 std::function 不含目标，则称它为空。调用空 std::function 的目标导致抛出 std::bad_function_call 异常。
std::function 满足可复制构造 (CopyConstructible) 和可复制赋值 (CopyAssignable) 。
成员类型
| 类型 | 定义 |
result_type
|
R
|
argument_type(C++17 中弃用)(C++20 中移除)
|
若 sizeof...(Args)==1 且 T 是 Args... 中首个且唯一的类型，则为 T
|
first_argument_type(C++17 中弃用)(C++20 中移除)
|
若 sizeof...(Args)==2 且 T1 是 Args... 中二个类型的第一个，则为 T1
|
second_argument_type(C++17 中弃用)(C++20 中移除)
|
若 sizeof...(Args)==2 且 T2 是 Args... 中二个类型的第二个，则为 T2
|
成员函数
| 构造新的 std::function 实例 (公开成员函数) | |
| 析构 std::function 实例 (公开成员函数) | |
| 为内容赋值 (公开成员函数) | |
| 交换内容 (公开成员函数) | |
| (C++17 中移除) |
为内容赋值一个新的目标 (公开成员函数) |
| 检查是否包含了有效的目标 (公开成员函数) | |
| 调用其目标 (公开成员函数) | |
目标访问 | |
| 获得目标对象的 typeid (公开成员函数) | |
| 获得指向 std::function 所存储的目标的指针 (公开成员函数) | |
非成员函数
| (C++11) |
特化 std::swap 算法 (函数模板) |
| (C++20 中移除) |
比较 std::function 和 nullptr (函数模板) |
辅助类
| (C++11) (C++17 前) |
特化 std::uses_allocator 类型特性 (类模板特化) |
推导指引(C++17 起)
注解
|
当结果类型为引用的 |
(C++23 前) |
|
若一个函数或函数对象（包括无尾随返回类型的 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; }); // 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() { // 存储自由函数 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); }; // 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) << "; "; } }
可能的输出：
-9 42 31337 314160 314160 num_: 314159 314161 314162 18 5! = 120; 6! = 720; 7! = 5040;
参阅
| (C++23) |
包装具有指定函数调用签名的任意类型的可调用对象 (类模板) |
| (C++11) |
调用空的 std::function 时抛出的异常 (类) |
| (C++11) |
从成员指针创建出函数对象 (函数模板) |