R Language
Rcpp

Code en ligne Compiler

Rcpp dispose de deux fonctions qui permettent la compilation de code en ligne et l'exportation directement dans R: cppFunction() et evalCpp() . Une troisième fonction appelée sourceCpp() existe pour lire le code C ++ dans un fichier séparé, mais peut être utilisée comme cppFunction() .

Voici un exemple de compilation d'une fonction C ++ dans R. Notez l'utilisation de "" pour entourer la source.

# 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)

Pour comprendre rapidement une expression C ++, utilisez:

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

Attributs Rcpp

Rcpp Attributes rend le processus de travail avec R et C ++ simple. La forme des attributs prend:

// [[Rcpp::attribute]]

L'utilisation d'attributs est généralement associée à:

// [[Rcpp::export]]

qui est placé directement au-dessus d'un en-tête de fonction déclaré lors de la lecture d'un fichier C ++ via sourceCpp() .

Vous trouverez ci-dessous un exemple de fichier C ++ externe utilisant des attributs.

// 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
}

Pour utiliser ce fichier C ++ externe dans R , procédez comme suit:

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

Extension de Rcpp avec des plugins

Dans C ++, on peut définir différents indicateurs de compilation en utilisant:

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

Liste des plugins intégrés:

// 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)]]

Spécification de dépendances de construction supplémentaires

Pour utiliser des packages supplémentaires dans l'écosystème Rcpp, le fichier d'en-tête correct peut ne pas être Rcpp.h mais Rcpp<PACKAGE>.h (par exemple pour RcppArmadillo ). Il doit généralement être importé et la dépendance est indiquée dans

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

Exemples:

// 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)]]