Skip to content
/ cpp11 Public
forked from r-lib/cpp11

cpp11 is a header-only R package that helps R package developers handle R objects with C++ code.

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md
Notifications You must be signed in to change notification settings

bkietz/cpp11

 
 

Repository files navigation

cpp11

R build status codecov Lifecycle: experimental CRAN status

cpp11 is a header-only R package that helps R package developers handle R objects with C++ code. Its goals and syntax are similar to the excellent Rcpp package.

Using cpp11 in a package

To add cpp11 to an existing package, put your C++ files in the src/ directory and add the following to your DESCRIPTION file:

LinkingTo: cpp11
SystemRequirements: C++11

Then decorate C++ functions you want to expose to R with [[cpp11::register]]. Note that this is a C++11 attribute, not a comment like is used in Rcpp.

cpp11 has no hard dependencies and does not use a shared library, so it is straightforward and reliable to use in packages.

Alternatively, you can vendor the current installed version of cpp11 headers into your package with cpp11::vendor_cpp11(). This ensures the headers will remain unchanged until you explicitly update them.

Getting started

See vignette("cpp11") to get started using cpp11 in your scripts, particularly if you are new to C++ programming.

Motivations

Rcpp has been a widely successful project, however over the years a number of issues and additional C++ features have arisen. Adding these features to Rcpp would require a great deal work, or in some cases would be impossible without severely breaking backwards compatibility.

cpp11 is a ground up rewrite of C++ bindings to R with different design trade-offs and features.

Changes that motivated cpp11 include:

See vignette("motivations") for full details on the motivations for writing cpp11.

Conversion from Rcpp

See vignette("converting") if you are already familiar with Rcpp or have an existing package that uses Rcpp and want to convert it to use cpp11.

Internals

See vignette("internals") for details on the cpp11 implementation or if you would like to contribute to cpp11.

Code of Conduct

Please note that the cpp11 project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Thanks

cpp11 would not exist without Rcpp. Thanks to the Rcpp authors, Dirk Eddelbuettel, Romain Francois, JJ Allaire, Kevin Ushey, Qiang Kou, Nathan Russell, Douglas Bates and John Chambers for their work writing and maintaining Rcpp.

About

cpp11 is a header-only R package that helps R package developers handle R objects with C++ code.

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE
MIT
LICENSE.md

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C++ 78.1%
  • R 21.7%
  • Makefile 0.2%