C++11 包装器function

文章首发公众号：iDoitnow

C++提供了多个包装器，它们主要是为了给其他编程接口提供更一致或更合适的接口。C++11提供了多个包装器，这里我们重点了解一下包装器function。

对于function, C++ 参考手册给出的定义为：

类模板 std::function 是通用多态函数封装器。 std::function 的实例能存储、复制及调用任何可调用 (Callable) 目标——函数、 lambda 表达式、 bind 表达式或其他函数对象，还有指向成员函数指针和指向数据成员指针。

C++11为什么要引入function

我们先看一个例子：

#include <iostream>

template <typename T, typename F>
T use_f(T v, F f) {
    static int count = 0;
    count++;
    std::cout << " use_f count = " << count << ", &count = " << &count
        << std::endl;
    return f(v);
}

class Fp {
    private:
    double z_;

    public:
    Fp(double z = 1.0) : z_(z) {}
    double operator()(double p) { return z_ * p; }
};

class Fq {
    private:
    double z_;

    public:
    Fq(double z = 1.0) : z_(z) {}
    double operator()(double q) { return z_ + q; }
};

double dub(double x) { return 2.0 * x; }
double square(double x) { return x * x; }
int main() {
    using std::cout;
    using std::endl;
    double y = 1.21;
    cout << "Function pointer dub:\n";
    /*dub是函数名（函数名是一个指针），
    因此参数F对应的类型为double(*)double,
    即一个指向（接受一个double参数并返回一个double的）函数指针*/
    cout << " " << use_f(y, dub) << endl; 
    cout << "Function pointer square:\n";
    cout << " " << use_f(y, square) << endl;//同上
    
    cout << "Function object Fp:\n";
    //Fp(5.0)是一个参数对象，F对应的类型为Fp
    cout << " " << use_f(y, Fp(5.0)) << endl;
    cout << "Function object Fq:\n";
    //Fq(5.0)是一个参数对象，F对应的类型为Fq
    cout << " " << use_f(y, Fq(5.0)) << endl;
    
    cout << "Lambda expression 1:\n";
    //此处是一个lambda表达式，F对应的类型为该lambda表达式使用的类型
    cout << " " << use_f(y, [](double u) { return u * u; }) << endl;
    cout << "Lambda expression 2:\n";
    ////此处是一个lambda表达式，F对应的类型为该lambda表达式使用的类型
    cout << " " << use_f(y, [](double u) { return u + u / 2.0; }) << endl;
    return 0;
}

程序通过一个模板函数use_f使用参数f表示调用的类型，然后将f(v)返回。在主函数中我们6次调用模板函数，对于前两个调用的use_f为同一个实例化。后面四个，每一个都有其对应use_f的实例化。实际上，上述代码的运行结果如下：

Function pointer dub:
  use_f count = 1, &count = 0x555555756140
2.42
Function pointer square:
  use_f count = 2, &count = 0x555555756140
1.4641
Function object Fp:
  use_f count = 1, &count = 0x555555756144
6.05
Function object Fq:
  use_f count = 1, &count = 0x555555756148
6.21
Lambda expression 1:
  use_f count = 1, &count = 0x555555756138

从运行结果中，我们可以看出，在这六次调用中use_f的实例化了5次。使用模板函数，看似统一了操作形式，但其对于不同类型的F对模板函数都要进行一次实例化，这大大增加了编译的时长，并使头文件也增大，同时也降低了代码的执行效率。为了解决这类问题，我们首先能想到的解决办法就是：降低use_f的实例化的次数，理想的情况下是：在这6次循环调用的时候，调用同一个use_f的实例。针对上述例子，根据代码注释的分析，如果我们能将这6次调用中模板函数中F的类型保持统一，就可以像第一、二次调用的情况类似，使这六次调用同一个use_f的实例成为可能。

针对例子中的函数指针、函数对象和lambda表达式，它们有一个共同的特征：都是接受一个double参数并返回一个double值。也就是它们的调用特征标（它们的特征标都是double(double)）相同。这便是function解决这个问题的关键。【注：调用特征标是由返回类型和参数类型列表决定的，其格式为：返回类型(参数类型列表)，其中每个参数类型用逗号分隔。】

因此，C++11引入了function包装器。function包装器可以简单理解为一个接口，它可以将特征标相同的函数指针、函数对象和lambda表达式等统一定义为一类特殊的对象。

function的用法

包装器function的本质是一个模板，它是在头文件functional中声明，其使用方法如下：

template< class >
class function; 

template< class R, class... Args >
class function<R(Args...)>;

其中R为被调用函数的返回类型，Args为被调用函数的形参。存储的可调用对象被称为std::function的目标，如果目标为空，则调用空的function会导致抛出std::bad_function_call异常。

示例：

#include <functional>
#include <iostream>

void print_num(int i) { std::cout << i << '\n'; }

int main() {
  // 存储自由函数
  std::function<void(int)> f_display = print_num;
  f_display(-9);

  // 存储 lambda
  std::function<double(double)> f_dub = [](double a) { return 2.0 * a; };
  std::cout << f_dub(2) << '\n';

  // 存储目标为空
  std::function<int()> f = nullptr;
  try {
    f();
  } catch (const std::bad_function_call& e) { //抛出异常
    std::cout << e.what() << '\n';
  }
}

输出结果为：

-9
4
bad_function_call

在了解完function的用法之后，回到我们最开始的问题，其中，6次循环中要处理的目标的特征标均为double(double)，因此，我们班使用function包装器将它们将统一“包装”成function<double(double)类型，这样模板函数use_f将只实例化一次。使用function包装器改进后的代码如下所示：

#include <functional>
#include <iostream>

template <typename T, typename F>
T use_f(T v, F f) {
  static int count = 0;
  count++;
  std::cout << " use_f count = " << count << ", &count = " << &count
            << std::endl;
  return f(v);
}

class Fp {
 private:
  double z_;

 public:
  Fp(double z = 1.0) : z_(z) {}
  double operator()(double p) { return z_ * p; }
};

class Fq {
 private:
  double z_;

 public:
  Fq(double z = 1.0) : z_(z) {}
  double operator()(double q) { return z_ + q; }
};

double dub(double x) { return 2.0 * x; }
double square(double x) { return x * x; }
int main() {
  using std::cout;
  using std::endl;
  using std::function;
  double y = 1.21;
  typedef function<double(double)> fdd;  // simplify the type declaration

  cout << "Function pointer dub:\n";
  cout << " " << use_f(y, fdd(dub)) << endl;
  cout << "Function pointer square:\n";
  cout << " " << use_f(y, fdd(square)) << endl;
  cout << "Function object Fp:\n";
  cout << " " << use_f(y, fdd(Fq(10.0))) << endl;
  cout << "Function object Fq:\n";
  cout << " " << use_f(y, fdd(Fp(10.0))) << endl;
  cout << "Lambda expression 1:\n";
  cout << " " << use_f(y, fdd([](double u) { return u * u; })) << endl;
  cout << "Lambda expression 2:\n";
  cout << " " << use_f<double>(y, fdd([](double u) { return u + u / 2.0; }))
       << endl;

  return 0;
}

输出结果为：

Function pointer dub:
  use_f count = 1, &count = 0x555555758134
2.42
Function pointer square:
  use_f count = 2, &count = 0x555555758134
1.4641
Function object Fp:
  use_f count = 3, &count = 0x555555758134
11.21
Function object Fq:
  use_f count = 4, &count = 0x555555758134
12.1
Lambda expression 1:
  use_f count = 5, &count = 0x555555758134
1.4641
Lambda expression 2:
  use_f count = 6, &count = 0x555555758134
1.815

从输出结果可以看出，use_f确实只实例化了一次，增加了编码效率，6次循环调用同一个函数，增加了代码额执行效率。

总结

function包装器将可调用对象的类型进行统一，便于我们对其进行统一化管理，同时，使用function包装器可以解决模板效率低下，实例化多份的问题。

参考文献

C++ Primer Plus(第六版) - 第18章 探讨C++新标准
C++ 参考手册