37 Rcpp先容

为了提高R程序的运行效率, 可以尽量使用向量化编程, 减少循环, 尽量使用内建函数。 对于效率的瓶颈, 尤其是设计迭代算法时, 可以采用编译代码, 而Rcpp扩展包可以很容易地将C++代码连接到R程序中, 并且支撑在C++中使用类似于R的数据类型。

没有学过C++语言的读者, 如果需要编写比较独立的不太依赖于R的已有功能的算法, 可以考虑学习使用Julia语言编写。 Julia语言是最近几年才发明的一种比R更现代、理念更先进的程序语言, 其运行效率一般比R高得多, 经常接近编译代码的效率。

Rcpp可以很容易地把C++代码与R程序连接在一起, 可以从R中直接调用C++代码而不需要用户关心那些繁琐的编译、链接、接口问题。 可以在R数据类型和C++数据类型之间容易地转换。

因为涉及到编译, 所以Rcpp比一般的扩展包有更多的安装要求: 除了要安装Rcpp包之外, MS Windows用户还需要安装RTools包, 这是用于C, C++, Fortran程序编译链接的开发工具包, 是自由App。 用户的应用程序路径(PATH)中必须有RTools包可实行程序的路径 (安装RTools可以自动设置)。 如果Rcpp不能找到编译器, 可以把编译器安装到Rcpp默认的位置。 Mac系统的用户可以从应用商店安装XcodeApp, Linux操作系统可以在操作系统命令行用如下命令安装编译App:

sudo apt-get install r-base-dev

在MS Windows系统中, 从CRAN网站下载RTools工具包, 并将其安装到默认位置C:\RTools中, 否则RStudio中使用Rcpp可能会出错。 注意, RStudio自己的自动安装RTools的功能可能有问题, 安装后不能正常编译含有Rcpp的Rmd文件。

Rcpp支撑把C++代码写在R源程序文件内, 实行时自动编译连接调用; 也支撑把C++代码保存在单独的源文件中, 实行R程序时自动编译连接调用; 对较复杂的问题, 应制作R扩展包, 利用构建R扩展包的方法实现C++代码的编译连接, 这时接口部分也可以借助Rcpp属性功能或模块功能完成。

37.1 Rcpp的用途

  • 把已经用R代码完成的程序中运行速度瓶颈部分改写成C++代码, 提高运行效率。

  • 对于C++或C程序源代码或二进制代码提供的函数库, 可以用Rcpp编写C++界面程序进行R与C++程序的输入、输出的传送, 并在C++界面程序中调用外来的函数库。

  • 注意,用Rcpp编写C++程序, 不利于把程序脱离R运行或被其他的C++程序调用。 当然,可以只把Rcpp作为界面, 主要的算法引擎完全不用Rpp的数据类型。

  • RInside扩展包支撑把R嵌入到C++主程序中。

37.2 Rcpp入门样例

37.2.1cppFunction()转换简单的C++函数—Fibnacci例子

考虑用C++程序计算Fibonacci数的问题。 Fibonacci数满足\(f_0=0, f_1=1, f_t=f_{t-1}+ f_{t-2}\)

可以使用如下R代码,其中有一部分C++代码, 用cppFunction转换成了R可以调用的同名R函数。

编译、链接、导入是在后台由Rcpp控制自动进行的, 不需要用户去设置编译环境, 也不需要用户实行编译、链接、导入R的工作。 在没有修改C++程序时, 同一R会话期间重新运行不必重新编译。

上面的Fibonacci函数仅接受标量数值作为输入, 不允许向量输入。 这个例子也说明RCpp变异的C++函数允许输入标量(int, double, bool), 输出标量(int, double, bool)。

从算法角度评价, 这个计算Fibonacci序列的算法是极其低效的, 其算法规模是\(O(2^n)\)\(n\)是自变量值。

37.2.2sourceCpp()转换C++程序—正负交替迭代例子

\(x_t, t=1,2,\dots,n\)保存在R向量x中, 令 \[\begin{aligned} y_1 =& x_1 \\ y_t =& (-1)^t y_{t-1} + x_t, \ t=2,\dots,n \end{aligned}\] 希翼用C++函数对输入序列x计算输出y,并用R调用这样的函数。

下面的程序用R函数sourceCpp() 把保存在R字符串中的C++代码编译并转换为同名的R函数。

这个例子说明C++程序可以直接写在R程序文件内 (保存为R多行字符串), 用sourceCpp()函数编译。

Rcpp包为C++提供了一个NumericVector数据类型, 用来存储数值型向量。 用成员函数size()访问其大小, 用方括号下标访问其元素。

C程序中定义的函数可以返回NumericVector数据类型, 将自动转换为R的数值型向量。

特殊的注释//[[Rcpp::export]] 用来指定哪些C++函数是要转换为R函数的。 这叫做Rcpp属性(attributes)功能。

37.2.3sourceCpp()转换C++源文件中的程序—正负交替迭代例子

直接把C++代码写在R源程序内部的好处是不用管理多个源文件, 缺点是当C++代码较长时, 不能利用专用C++编辑环境和调试环境, 出错时显示的错误行号不好定位, 而且把代码保存在R字符串内, C++代码中用到字符时需要特殊语法。 所以,稍复杂的C++代码应该放在单独的C++源文件内。

假设上面的iters函数的C++代码单独存入了一个iters.cpp源文件中,内容如下:

用如下的sourceCpp()函数把C++源文件中代码编译并转换为R可访问的同名函数, 测试调用:

37.2.4sourceCpp()转换C++源程序文件—卷积例子

考虑向量\(\boldsymbol x=(x_0, x_1, \dots, x_{n-1})\), \(\boldsymbol y=(y_0, y_1, \dots, y_{m-1})\), 定义\(\boldsymbol x\)\(\boldsymbol y\) 的离散卷积\(\boldsymbol z=(z_0, z_1, \dots, z_{n+m-2})\)\[\begin{aligned} z_k = \sum_{(i,j):\, i+j=k} x_i y_j = \sum_{i=\max(0, k-m+1)}^{\min(k,n)} x_i y_{k-i}. \end{aligned}\]

假设如下的C++程序保存到了源文件conv.cpp中。

如下的代码用sourceCpp()函数把上面的C++源文件conv.cpp 自动编译并转换为同名的R函数, 进行测试:

37.2.5 在Rmd文件中使用C++源程序文件

在Rmd文件中, 可以使用特殊的Rcpp代码块, 其中包含C++源代码, 可以直接起到对其调用sourceCpp()的作用。

但是,目前在MS Windows系统下仍有错误, 需要将RTools安装在默认路径, 即C:\RTools\binC:\RTools\mingw_64\bin中, 并可能需要将这两个路径人为地添加到系统的PATH变量中, 办法是“Windows程序–Windows系统–控制面板–系统和安全–系统–高级系统设置–高级–环境变量–系统变量”, 其中的PATH变量是用分号分开的可实行程序搜索路径, 将其中添加RTools包的C:\RTools\binC:\RTools\mingw_64\bin

设置好以后, 在Rmd文件中输入如下的代码块:

```{Rcpp}
#include <Rcpp.h>
using namespace Rcpp;

//[[Rcpp::export]]
NumericVector convolveCpp(
    NumericVector a, NumericVector b){
  int na = a.size(), nb = b.size();
  int nab = na + nb - 1;
  NumericVector xab(nab);

  for(int i=0; i < na; i++)
    for(int j=0; j < nb; j++)
      xab[i+j] += a[i] * b[j];

  return xab;
}
```

可以使得C++函数convolveCpp()被编译并转换成R可以调用的同名函数, 调用如:

Rcpp代码块也可以加cache=TRUE选项, 使得C++程序在没有修改时不必每次重新编译。