R Language
Rcpp

Compilazione codice in linea

Rcpp presenta due funzioni che consentono la compilazione di codice in linea ed esportazione direttamente in R: cppFunction() ed evalCpp() . Esiste una terza funzione chiamata sourceCpp() per leggere in codice C ++ in un file separato, sebbene possa essere usata come cppFunction() .

Di seguito è riportato un esempio di compilazione di una funzione C ++ all'interno di R. Nota l'uso di "" per circondare la sorgente.

# Note - This is R code.
# cppFunction in Rcpp allows for rapid testing.
require(Rcpp)

# Creates a function that multiples each element in a vector
# Returns the modified vector.
cppFunction("
NumericVector exfun(NumericVector x, int i){
x = x*i;
return x;
}")

# Calling function in R
exfun(1:5, 3)

Per comprendere rapidamente un'espressione C ++, utilizzare:

# Use evalCpp to evaluate C++ expressions
evalCpp("std::numeric_limits<double>::max()")
## [1] 1.797693e+308

Attributi Rcpp

Rcpp Attributes rende il processo di lavorare con R e C ++ direttamente. La forma degli attributi prende:

// [[Rcpp::attribute]]

L'uso di attributi è in genere associato a:

// [[Rcpp::export]]

che viene posto direttamente sopra l'intestazione di una funzione dichiarata durante la lettura in un file C ++ tramite sourceCpp() .

Di seguito è riportato un esempio di un file C ++ esterno che utilizza gli attributi.

// Add code below into C++ file Rcpp_example.cpp

#include <Rcpp.h>
using namespace Rcpp;

// Place the export tag right above function declaration.
// [[Rcpp::export]]
double muRcpp(NumericVector x){

    int n = x.size(); // Size of vector
    double sum = 0; // Sum value

    // For loop, note cpp index shift to 0
    for(int i = 0; i < n; i++){
        // Shorthand for sum = sum + x[i]
        sum += x[i];
    }

    return sum/n; // Obtain and return the Mean
}

// Place dependent functions above call or
// declare the function definition with:
double muRcpp(NumericVector x);

// [[Rcpp::export]]
double varRcpp(NumericVector x, bool bias = true){

    // Calculate the mean using C++ function
    double mean = muRcpp(x);
    double sum = 0;

    int n = x.size();

    for(int i = 0; i < n; i++){
        sum += pow(x[i] - mean, 2.0); // Square
    }

    return sum/(n-bias); // Return variance
}

Per utilizzare questo file C ++ esterno in R , facciamo quanto segue:

require(Rcpp)

# Compile File
sourceCpp("path/to/file/Rcpp_example.cpp")

# Make some sample data
x = 1:5

all.equal(muRcpp(x), mean(x))
## TRUE

all.equal(varRcpp(x), var(x))
## TRUE

Estensione di Rcpp con plugin

All'interno di C ++, si possono impostare diversi flag di compilazione usando:

 // [[Rcpp::plugins(name)]]

Elenco dei plugin incorporati:

// built-in C++11 plugin
// [[Rcpp::plugins(cpp11)]]

// built-in C++11 plugin for older g++ compiler
// [[Rcpp::plugins(cpp0x)]]

// built-in C++14 plugin for C++14 standard
// [[Rcpp::plugins(cpp14)]]

// built-in C++1y plugin for C++14 and C++17 standard under development
// [[Rcpp::plugins(cpp1y)]]

// built-in OpenMP++11 plugin
// [[Rcpp::plugins(openmp)]]

Specifica di dipendenze di build aggiuntive

Per utilizzare pacchetti aggiuntivi all'interno dell'ecosistema Rcpp, il file di intestazione corretto potrebbe non essere Rcpp.h ma Rcpp<PACKAGE>.h (come ad es. Per RcppArmadillo ). In genere deve essere importato e quindi la dipendenza viene dichiarata all'interno

// [[Rcpp::depends(Rcpp<PACKAGE>)]]

Esempi:

// Use the RcppArmadillo package
// Requires different header file from Rcpp.h
#include <RcppArmadillo.h>
// [[Rcpp::depends(RcppArmadillo)]]

// Use the RcppEigen package
// Requires different header file from Rcpp.h
#include <RcppEigen.h>
// [[Rcpp::depends(RcppEigen)]]