Seamless R and C++ Integration
The 'Rcpp' package provides R functions as well as C++ classes which
offer a seamless integration of R and C++. Many R data types and objects can be
mapped back and forth to C++ equivalents which facilitates both writing of new
code as well as easier integration of third-party libraries. Documentation
about 'Rcpp' is provided by several vignettes included in this package, via the
'Rcpp Gallery' site at <http://gallery.rcpp.org>, the paper by Eddelbuettel and
Francois (2011, JSS), and the book by Eddelbuettel (2013, Springer); see
'citation("Rcpp")' for details on these last two.
Seamless R and C++ Integration
The Rcpp package provides R functions and a C++ library facilitating the integration of R and C++.
R data types (
SEXP) are matched to C++ objects in a class hierarchy. All R
types are supported (vectors, functions, environment, etc ...) and each
type is mapped to a dedicated class. For example, numeric vectors are
represented as instances of the Rcpp::NumericVector class, environments are
represented as instances of Rcpp::Environment, functions are represented as
Rcpp::Function, etc ...
vignette (also published as a JSS paper) provides a good
entry point to Rcpp as do the Rcpp website, the
Rcpp page and the
Rcpp Gallery. Full documentation
is provided by the Rcpp book.
Conversion from C++ to R and back is driven by the templates
Rcpp::as which are highly flexible and extensible, as documented
in the Rcpp-extending vignette.
Rcpp also provides Rcpp modules, a framework that allows exposing C++ functions and classes to the R level. The Rcpp-modules vignette details the current set of features of Rcpp-modules.
Rcpp includes a concept called Rcpp sugar that brings many R functions into C++. Sugar takes advantage of lazy evaluation and expression templates to achieve great performance while exposing a syntax that is much nicer to use than the equivalent low-level loop code. The Rcpp-sugar gives an overview of the feature.
Rcpp attributes provide a high-level syntax for declaring C++ functions as callable from R and automatically generating the code required to invoke them. Attributes are intended to facilitate both interactive use of C++ within R sessions as well as to support R package development. Attributes are built on top of Rcpp modules and their implementation is based on previous work in the inline package. See the Rcpp-atttributes vignettes for more details.
The package ships with nine pdf vignettes.
Additional documentation is available via the JSS paper by Eddelbuettel and Francois (2011, JSS) paper (corresponding to the 'intro' vignette) and the book by Eddelbuettel (2013, Springer); see 'citation("Rcpp")' for details.
The Rcpp Gallery showcases over one hundred fully documented and working examples.
A number of examples are included as are 1359 unit tests in 591 unit test functions provide additional usage examples.
An earlier version of Rcpp, containing what we now call the 'classic Rcpp API' was written during 2005 and 2006 by Dominick Samperi. This code has been factored out of Rcpp into the package RcppClassic, and it is still available for code relying on the older interface. New development should always use this Rcpp package instead.
Other usage examples are provided by packages using Rcpp. As of November 2016, there are 839 CRAN packages using Rcpp, a further 89 BioConductor packages in its current release as well as an unknown number of GitHub, Bitbucket, R-Forge, ... repositories using Rcpp. All these packages provide usage examples for Rcpp.
Released and tested versions of Rcpp are available via the CRAN network, and can be installed from within R via
To install from source, ensure you have a complete package development environment for R as discussed in the relevant documentation; also see questions 1.2 and 1.3 in the Rcpp-FAQ.
Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou, Nathan Russell, Doug Bates, and John Chambers
GPL (>= 2)
Functions in Rcpp
|cppFunction||Define an R Function with a C++ Implementation|
|demangle||c++ type information|
|C++Class-class||Reflection information for an internal c++ class|
|C++Object-class||c++ internal objects|
|evalCpp||Evaluate a C++ Expression|
|loadRcppModules-deprecated||Loads Rcpp modules on package startup|
|formals<--methods||Set the formal arguments of a C++ function|
|exposeClass||Create an Rcpp Module to Expose a C++ Class in R|
|loadModule||Load an Rcpp Module into a Package|
|Rcpp.plugin.maker||Facilitating making package plugins|
|Rcpp.package.skeleton||Create a skeleton for a new package depending on Rcpp|
|LdFlags||(Deprecated) Rcpp Linker Flags|
|RcppUnitTests||Rcpp : unit tests results|
|registerPlugin||Register an inline plugin|
|Rcpp-deprecated||Deprecated Functions in the Rcpp Package|
|setRcppClass||Create a Class Extending a C++ Class|
|Module||Retrieves an Rcpp module|
|compilerCheck||Check for Minimal (g++) Compiler Version|
|compileAttributes||Compile Rcpp Attributes for a Package|
|populate||Populates a namespace or an environment with the content of a module|
|sourceCpp||Source C++ Code from a File or String|
|Rcpp-internal||Rcpp internal functions|
|Rcpp-package||R / C++ interface|
Last month downloads
|URL||http://www.rcpp.org, http://dirk.eddelbuettel.com/code/rcpp.html, https://github.com/RcppCore/Rcpp|
|License||GPL (>= 2)|
|MailingList||Please send questions and comments regarding Rcpp to email@example.com|
|Packaged||2017-01-14 14:22:14 UTC; edd|
Include our badge in your README