Rcpp - R和C++的高性能集成框架

Rcpp：R和C++的无缝集成

概述

Rcpp包通过R函数和（仅头文件的）C++库实现了R和C++的集成。

所有底层R类型和对象，即R内部由SEXP表示的所有内容，都与相应的C++对象匹配。这涵盖了从向量、矩阵或列表到环境、函数等所有内容。每个SEXP变体都自动映射到专用的C++类。例如，数值向量由Rcpp::NumericVector类的实例表示，环境由Rcpp::Environment的实例表示，函数由Rcpp::Function表示，等等... Rcpp介绍小品文（现已发表为TAS论文；早期介绍也作为JSS论文发表）为Rcpp提供了一个很好的入门点，Rcpp网站、Rcpp页面和Rcpp画廊也是如此。Rcpp书籍提供了完整的文档。

其他亮点：

C++到R的转换以及反向转换由模板Rcpp::wrap和Rcpp::as驱动，这些模板具有高度的灵活性和可扩展性，详见Rcpp-extending小品文。
Rcpp还提供了Rcpp模块，这是一个允许在R级别上暴露C++函数和类的框架。Rcpp-modules小品文详细介绍了Rcpp模块的当前功能集。
Rcpp包含一个称为Rcpp sugar的概念，它将许多R函数引入C++。Sugar利用惰性求值和表达式模板，在提供比等效低级循环代码更易用的语法的同时，实现了出色的性能。Rcpp-sugar小品文概述了这一特性。
Rcpp属性提供了一种高级语法，用于声明可从R调用的C++函数，并自动生成调用它们所需的代码。属性旨在促进C++在R会话中的交互使用，并支持R包开发。属性构建在Rcpp模块之上，其实现基于inline包中的前期工作。有关更多详细信息，请参阅Rcpp-attributes小品文。

文档

该包附带十个PDF小品文，包括一个最近的Rcpp介绍，现已作为TAS论文发表（并作为PeerJ预印本）。还提供了一个早期介绍，该介绍已作为JSS论文发表。其他小品文包括 Rcpp FAQ 和 Rcpp Attributes 简介。更多文档可通过 Eddelbuettel 所著的 Rcpp 书籍（2013年，Springer出版）获取；详情请参见 'citation("Rcpp")'。

性能

Rcpp 遵循 C++ 的座右铭"你只为使用的部分付费"，不会带来运行时性能损失：在直接比较中，Rcpp 的表现优于相关包，详情请参见此仓库。

编译时性能可通过选择组件进行调优。但值得注意的是，使用 ccache 将（强烈）主导所有此类组件选择，我们之前推荐过使用它。

示例

Rcpp Gallery 展示了一百多个完整记录的可运行示例。RcppExamples 包包含一些涵盖核心数据类型的基本示例。

包中包含许多示例，以及一千多个单元测试，提供了额外的使用示例。

Rcpp 的早期版本（现称为"经典 Rcpp API"）由 Dominick Samperi 于 2005 年和 2006 年编写。这些代码已从 Rcpp 中分离出来，形成 RcppClassic 包，仍可用于依赖旧接口的代码。新开发应始终使用这个 Rcpp 包。

使用 Rcpp 的其他包也提供了使用示例。截至 2024 年 1 月初，有 2791 个 CRAN 包使用 Rcpp（占所有包的 13.8%，包含编译代码的包中占 59.9%），当前版本的 BioConductor 中还有 254 个包，以及未知数量的 GitHub、Bitbucket、R-Forge 等仓库使用 Rcpp。所有这些包都为 Rcpp 提供了使用示例。该包被广泛使用，已被下载超过 7810 万次（根据 CRAN 云镜像的部分日志）。

安装

CRAN

CRAN 上发布的 Rcpp 版本经过仔细测试和策划。CRAN 确保它们能在所有测试环境中与所有其他 CRAN 包互操作。已发布和测试的版本可通过 CRAN 网络的所有镜像获得，可以在 R 中通过以下命令安装：

install.packages("Rcpp")

候选版本

对于最近的几个版本，我们还在 Rcpp Drat Repo 上提供了临时候选版本。可以通过临时设置 drat 仓库来安装 drat 仓库中的版本：

install.packages("Rcpp", repos="https://RcppCore.github.io/drat")

或者通过更永久地设置 drat 仓库（如 drat 包文档中所述）。

在实际发布之前测试候选版本会有所帮助。如果可能，请运行此测试。

源码

要从源码安装，请确保您有完整的 R 包开发环境，详见相关文档；另请参阅 Rcpp-FAQ 中的问题 1.2 和 1.3。

不常见版本和平台

如果您想在其他（未在 CRAN 上测试的）平台上运行 Rcpp，或在早于上一版本的旧版本上运行，我们建议您进行尽职调查并相应测试。Rcpp 由一个资源有限的志愿者团队提供。我们努力测试 Rcpp 与数千个使用它的 CRAN 包的兼容性，但我们无法在过时的 R 版本或您的操作系统上进行测试。

支持

提问的最佳场所是 R-forge 上托管的 Rcpp-devel 邮件列表。请注意，为了减少垃圾邮件，您必须订阅才能发帖。也可以查阅列表存档，看看您的问题是否已被问过。

GitHub 仓库的问题追踪器是主要的错误报告接口。与其他网络资源一样，也可以搜索先前的问题。

作者

Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou, Nathan Russell, Iñaki Ucar, Doug Bates, 和 John Chambers

许可证

GPL (>= 2)