R Language
Rcpp

Inline-Code kompilieren

Rcpp bietet zwei Funktionen, die die Inline-Kompilierung von Code und den direkten Export in R ermöglichen: cppFunction() und evalCpp() . Eine dritte Funktion namens sourceCpp() existiert zum Lesen von C ++ - Code in einer separaten Datei. Sie kann jedoch ähnlich wie cppFunction() .

Unten ist ein Beispiel für das Kompilieren einer C ++ - Funktion in R. Beachten Sie die Verwendung von "" , um die Quelle zu umgeben.

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

Um einen C ++ - Ausdruck schnell zu verstehen, verwenden Sie:

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

Rcpp-Attribute

Rcpp Attributes macht das Arbeiten mit R und C ++ unkompliziert. Die Form der Attribute hat folgende Eigenschaften:

// [[Rcpp::attribute]]

Die Verwendung von Attributen ist normalerweise verbunden mit:

// [[Rcpp::export]]

Das wird direkt über einem deklarierten Funktionsheader platziert, wenn eine C ++ - Datei über sourceCpp() .

Nachfolgend finden Sie ein Beispiel für eine externe C ++ - Datei, die Attribute verwendet.

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

Um diese externe C ++ - Datei in R zu verwenden , führen wir folgende Schritte aus:

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

Rcpp mit Plugins erweitern

Innerhalb von C ++ können verschiedene Compilierungsflags gesetzt werden:

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

Liste der eingebauten Plugins:

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

Zusätzliche Build-Abhängigkeiten angeben

So verwenden Sie zusätzliche Pakete im RCPP Ökosystem, die korrekte Header - Datei möglicherweise nicht Rcpp.h aber Rcpp<PACKAGE>.h (wie zB für RcppArmadillo ). Normalerweise muss es importiert werden und dann wird die Abhängigkeit innerhalb angegeben

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

Beispiele:

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