Repository files navigation

cpp11 helps you to interact with R objects using C++ code.Its goals and syntax are similar to the excellentRcpp package.

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

LinkingTo: cpp11

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

cpp11 is a header only library with no hard dependencies and does not use a shared library, so it is straightforward and reliable to use in packages without fear of compile-time and run-time mismatches.

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

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

Posit Community is the best place to ask for help using cpp11 or interfacing C++ with R.

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 of 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:

• Enforcingcopy-on-write semantics.
• Improving thesafety of using the R API from C++ code.
• SupportingALTREP objects.
• UsingUTF-8 strings everywhere.
• Applying newerC++11 features.
• Having a more straightforward,simpler implementation.
• Fastercompilation time with lower memory requirements.
• Beingcompletelyheader only to avoid ABI issues.
• Capable ofvendoring if desired.
• More robustprotection using a much more efficient linked list data structure.
• Growing vectors more efficiently.

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

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

• Welding R and C++ - Presentation at SatRday Columbus(slides)

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

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

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.