R Language
RCPP

Inline Code Compile

Rcpp har två funktioner som möjliggör inline och exportering av kod direkt till R: cppFunction() och evalCpp() . En tredje funktion som heter sourceCpp() finns för att läsa i C ++ -kod i en separat fil men kan användas liknar cppFunction() .

Nedan är ett exempel på att sammanställa en C ++ -funktion inom R. Notera användningen av "" att omge källan.

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

För att snabbt förstå ett C ++ -uttryck använder du:

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

Rcpp-attribut

Rcpp Attribut gör processen att arbeta med R och C ++ enkel. Formen för attribut tar:

// [[Rcpp::attribute]]

Användningen av attribut förknippas vanligtvis med:

// [[Rcpp::export]]

som placeras direkt ovanför en deklarerad funktionshuvud vid läsning i en C ++ sourceCpp() via sourceCpp() .

Nedan är ett exempel på en extern C ++ -fil som använder attribut.

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

För att använda denna externa C ++ -fil inom R , gör vi följande:

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

Utöka Rcpp med plugins

Inom C ++ kan man ställa in olika sammanställningsflaggor med hjälp av:

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

Lista över de inbyggda 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)]]

Ange ytterligare byggberoende

För att använda ytterligare paket i Rcpp-ekosystemet kan det hända att Rcpp.h Rcpp<PACKAGE>.h inte är Rcpp.h utan Rcpp<PACKAGE>.h (som t.ex. för RcppArmadillo ). Det måste vanligtvis importeras och därefter anges beroendet inom

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

Exempel:

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