Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enchufa2/rcppxptrutils
XPtr Add-Ons for 'Rcpp'
https://github.com/enchufa2/rcppxptrutils
cran r rcpp xptr
Last synced: 2 months ago
JSON representation
XPtr Add-Ons for 'Rcpp'
- Host: GitHub
- URL: https://github.com/enchufa2/rcppxptrutils
- Owner: Enchufa2
- License: other
- Created: 2017-07-31T14:00:33.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-05-24T19:12:55.000Z (over 2 years ago)
- Last Synced: 2024-09-14T12:09:09.755Z (4 months ago)
- Topics: cran, r, rcpp, xptr
- Language: R
- Homepage:
- Size: 29.3 KB
- Stars: 20
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
Awesome Lists containing this project
README
---
output: github_document
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# RcppXPtrUtils: XPtr Add-Ons for 'Rcpp'
[](https://github.com/Enchufa2/RcppXPtrUtils/actions/workflows/build.yml)
[](https://app.codecov.io/gh/Enchufa2/RcppXPtrUtils)
[](https://cran.r-project.org/package=RcppXPtrUtils)
[](https://cran.r-project.org/package=RcppXPtrUtils)
The **RcppXPtrUtils** package provides the means to compile user-supplied C++ functions with 'Rcpp' and retrieve an XPtr that can be passed to other C++ components.
## Installation
Install the release version from CRAN:
```{r, eval=FALSE}
install.packages("RcppXPtrUtils")
```
The installation from GitHub can be done with the [remotes](https://cran.r-project.org/package=remotes) package:
```{r, eval=FALSE}
remotes::install_github("Enchufa2/RcppXPtrUtils")
```
## Use case
Let's suppose we have a package with a core written in C++, connected to an R API with `Rcpp`. It accepts a user-supplied R function to perform some processing:
```{r, engine='Rcpp', eval=FALSE}
#include
using namespace Rcpp;
template
NumericVector core_processing(T func, double l) {
double accum = 0;
for (int i=0; i<1e3; i++)
accum += sum(as(func(3, l)));
return NumericVector(1, accum);
}
// [[Rcpp::export]]
NumericVector execute_r(Function func, double l) {
return core_processing(func, l);
}
```
But calling R from C++ is slow, so we can think about improving the performance by accepting a compiled function. In order to do this, the core can be easily extended to accept an `XPtr` to a compiled function:
```{r, engine='Rcpp', eval=FALSE}
typedef SEXP (*funcPtr)(int, double);
// [[Rcpp::export]]
NumericVector execute_cpp(SEXP func_, double l) {
funcPtr func = *XPtr(func_);
return core_processing(func, l);
}
```
```{r, engine='Rcpp', echo=FALSE}
#include
using namespace Rcpp;
template
NumericVector core_processing(T func, double l) {
double accum = 0;
for (int i=0; i<1e3; i++)
accum += sum(as(func(3, l)));
return NumericVector(1, accum);
}
// [[Rcpp::export]]
NumericVector execute_r(Function func, double l) {
return core_processing(func, l);
}
typedef SEXP (*funcPtr)(int, double);
// [[Rcpp::export]]
NumericVector execute_cpp(SEXP func_, double l) {
funcPtr func = *XPtr(func_);
return core_processing(func, l);
}
```
To easily leverage this feature, the `RcppXPtrUtils` package provides `cppXPtr()`, which compiles a user-supplied C++ function using `Rcpp::cppFunction()` and returns an `XPtr`:
```{r}
# compile the code above
# Rcpp::sourceCpp(code='...')
library(RcppXPtrUtils)
func_r <- function(n, l) rexp(n, l)
func_cpp <- cppXPtr("SEXP foo(int n, double l) { return rexp(n, l); }")
microbenchmark::microbenchmark(
execute_r(func_r, 1.5),
execute_cpp(func_cpp, 1.5)
)
```
The object returned by `cppXPtr()` is just an `externalptr` wrapped into an object of class `XPtr`, which stores the signature of the function. If you are a package author, you probably want to re-export `cppXPtr()` and ensure that user-supplied C++ functions comply with the internal signatures in order to avoid runtime errors. This can be done with the `checkXPtr()` function:
```{r, error=TRUE}
func_cpp
checkXPtr(func_cpp, "SEXP", c("int", "double")) # returns silently
checkXPtr(func_cpp, "int", c("int", "double"))
checkXPtr(func_cpp, "SEXP", c("int"))
checkXPtr(func_cpp, "SEXP", c("double", "int"))
```