Rcpp v1.0.0

0

Monthly downloads

0th

Percentile

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, <doi:10.18637/jss.v040.i08>), the book by Eddelbuettel (2013, <doi:10.1007/978-1-4614-6868-4>) and the paper by Eddelbuettel and Balamuta (2018, <doi:10.1080/00031305.2017.1375990>); see 'citation("Rcpp")' for details.

Readme

Rcpp Build Status License CRAN Dependencies Downloads Coverage Status

Seamless R and C++ Integration

The Rcpp package provides R functions and a (header-only for client packages) C++ library greatly facilitating the integration of R and C++.

All underlying R types and objects, i.e., everything a SEXP represents internally in R, are matched to corresponding C++ objects. This covers anything from vectors, matrices or lists to environments, functions and more. Each SEXP variant is automatically mapped to a dedicated C++ 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 ... The Rcpp-introduction vignette (now published as a TAS paper; an earlier introduction was 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.

Other highlights:

  • The conversion from C++ to R and back is driven by the templates Rcpp::wrap and 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.

Documentation

The package ships with nine pdf vignettes, including a recent introduction to Rcpp now published as a paper in TAS (and as a preprint in PeerJ). Also available is an earlier introduction which was published as a JSS paper)

Among the other vignettes are the Rcpp FAQ and the introduction to Rcpp Attributes. Additional documentation is available via the Rcpp book by Eddelbuettel (2013, Springer); see 'citation("Rcpp")' for details.

Examples

The Rcpp Gallery showcases over one hundred fully documented and working examples. The package RcppExamples contains a few basic examples covering the core data types.

A number of examples are included as are 1437 unit tests in 622 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 2018, there are 1490 CRAN packages using Rcpp, a further 150 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.

Installation

Released and tested versions of Rcpp are available via the CRAN network, and can be installed from within R via

install.packages("Rcpp")

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.

Support

The best place for questions is the Rcpp-devel mailing list hosted at R-forge. Note that in order to keep spam down, you must be a subscriber in order to post. One can also consult the list archives to see if your question has been asked before.

Another option is to use StackOverflow and its 'rcpp' tag. Search functionality (use rcpp in squared brackets as in [rcpp] my question terms to tag the query) is very valuable as many questions have indeed been asked, and answered, before.

The issue tickets at the GitHub repo are the primary bug reporting interface. As with the other web resources, previous issues can be searched as well.

Authors

Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou, Nathan Russell, Doug Bates, and John Chambers

License

GPL (>= 2)

Functions in Rcpp

Name Description
LdFlags-deprecated Deprecated Rcpp Linker Flags
Rcpp-deprecated Deprecated Functions in the Rcpp Package
compilerCheck Check for Minimal (g++) Compiler Version
compileAttributes Compile Rcpp Attributes for a Package
dependsAttribute Rcpp::depends Attribute
evalCpp Evaluate a C++ Expression
pluginsAttribute Rcpp::plugins Attribute
demangle c++ type information
cppFunction Define an R Function with a C++ Implementation
RcppUnitTests Rcpp : unit tests results
exportAttribute Rcpp::export Attribute
loadRcppModules-deprecated Loads Rcpp modules on package startup
loadModule Load an Rcpp Module into a Package
Rcpp.package.skeleton Create a skeleton for a new package depending on Rcpp
Rcpp.plugin.maker Facilitating making package plugins
exposeClass Create an Rcpp Module to Expose a C++ Class in R
populate Populates a namespace or an environment with the content of a module
Rcpp-internal Rcpp internal functions
Rcpp-package R / C++ interface
interfacesAttribute Rcpp::interfaces Attribute
formals<--methods Set the formal arguments of a C++ function
registerPlugin Register an inline plugin
sourceCpp Source C++ Code from a File or String
setRcppClass Create a Class Extending a C++ Class
Module Retrieves an Rcpp module
.DollarNames-methods completion
Module-class Rcpp modules
C++Class-class Reflection information for an internal c++ class
C++Constructor-class Class "C++Constructor"
C++Object-class c++ internal objects
C++OverloadedMethods-class Class "C++OverloadedMethods"
C++Field-class Class "C++Field"
C++Function-class Class "C++Function"
No Results!

Vignettes of Rcpp

Name
figures/bootstrap.pdf
figures/dist_graphs-1.pdf
figures/function_annotation_cpp.png
figures/samplePkg-files-light-bg.png
Rcpp-FAQ.Rmd
Rcpp-attributes.Rmd
Rcpp-extending.Rmd
Rcpp-introduction.Rmd
Rcpp-jss-2011.Rnw
Rcpp-modules.Rmd
Rcpp-package.Rmd
Rcpp-quickref.Rmd
Rcpp-sugar.Rmd
Rcpp-unitTests.pdf
Rcpp.bib
No Results!

Last month downloads

Details

Date 2018-11-05
VignetteBuilder knitr
URL http://www.rcpp.org, http://dirk.eddelbuettel.com/code/rcpp.html, https://github.com/RcppCore/Rcpp
License GPL (>= 2)
BugReports https://github.com/RcppCore/Rcpp/issues
MailingList Please send questions and comments regarding Rcpp to rcpp-devel@lists.r-forge.r-project.org
RoxygenNote 6.0.1
NeedsCompilation yes
Packaged 2018-11-06 03:02:42.98448 UTC; edd
Repository CRAN
Date/Publication 2018-11-07 20:00:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/Rcpp)](http://www.rdocumentation.org/packages/Rcpp)