• Integraremos el algoritmo de optimización Gradient Descent (implementación sencilla: librería Purple, ligeramente adaptada a nuestro problema)
• Aplicación al problema de regresion lineal multiple
• Resultado: función contenida en un paquete (GradDesc)

Rcpp::Rcpp.package.skeleton(name="GradDesc",path="/tmp")

## GradDesc
## ├── DESCRIPTION
## ├── GradDesc.Rproj
## ├── inst
## ├── man
## ├── NAMESPACE
## ├── R
## └── src
## 
## 4 directories, 3 files

## GradDesc
## ├── DESCRIPTION
## ├── inst
## │   └── include
## │       ├── ObjectiveFunction
## │       ├── OptimizationAlgorithm
## │       └── Utilities
## ├── man
## ├── NAMESPACE
## ├── R
## │   ├── GradDesc.R
## │   └── RcppExports.R
## └── src
##     ├── GradientDescent.cpp
##     ├── Makevars
##     ├── Makevars.win
##     ├── ObjectiveFunction.cpp
##     ├── OptimizationAlgorithm.cpp
##     ├── RcppExports.cpp
##     ├── RcppGradientDescent.cpp
##     ├── RcppModuloSumaCuadrados.cpp
##     ├── Rcpp_purple_wrappers.cpp
##     └── SumaCuadrados.cpp
## 
## 8 directories, 14 files

Fuentes de Purple incluidos en src/

• Ventaja: el paquete es "autocontenido". Es la forma habitual de distribución.
• Incluir todos los cabeceros de la clase en un directorio "include" (dentro del directorio del paquete)
• Las clases de la librería se compilan al instalar el paquete.
• Compilación del paquete con Build tools (devtools, RStudio). Utiliza fichero Makevars (Makevars.win):

## -*- mode: makefile; -*-

PKG_CXXFLAGS=-I../inst/include
## With R 3.1.0 or later, you can uncomment the following line to tell R to
## enable compilation with C++11 (where available)
CXX_STD = CXX11

Cómo funciona Rcpp:

RcppGradientDescent.cpp ([[Rcpp::export]]) -> src/RcppExports.cpp -> R/RcppExports.R (Función en R)

devtools::install(".", args="--no-multiarch")

• Macro RCPP_MODULE: permite exportar objetos directamente. Similar a // [[Rcpp::export]]
• Muy útil para exportar clases completas (constructores, métodos, etc)
• En src/ModuloSumaCuadrados.cpp definimos la clase GradientDescentSumaCuadradosClase

class GradientDescentSumaCuadradosClase {
    public:
        GradientDescentSumaCuadradosClase(SEXP A, SEXP y){
            //...
        }
        SEXP getMinimalArgument(){
            return Rcpp::wrap<Purple::Vector<double>>(gradient_descent.getMinimalArgument());
        }
        void setInitialArgument(SEXP vect_inicial){
            gradient_descent.setInitialArgument(Rcpp::as<Purple::Vector<double>>(vect_inicial));
        }
        //...
    private:
        Purple::GradientDescent gradient_descent;
        //...
    
};

• La exportamos como módulo. En src/ModuloSumaCuadrados.cpp:

class GradientDescentSumaCuadradosClase{
    //...
};
RCPP_MODULE(ModuloSumaCuadrados){
    using namespace Rcpp;

    class_<GradientDescentSumaCuadradosClase>( "GradientDescentSumaCuadradosClase" )

    .constructor<SEXP,SEXP>()

    .method( "solve", &GradientDescentSumaCuadradosClase::getMinimalArgument )
    .method( "setGradientNormGoal", &GradientDescentSumaCuadradosClase::setGradientNormGoal )
    .method( "setEvaluationGoal", &GradientDescentSumaCuadradosClase::setEvaluationGoal )
    .method( "starting_point", &GradientDescentSumaCuadradosClase::setInitialArgument )
    ;
}

• Hay que añadir en DESCRIPTION : RcppModules: ModuloSumaCuadrados
• Hay que establecer un punto de carga en un archivo .R: R/GradDesc.R: loadModule("ModuloSumaCuadrados",TRUE)

RCPP_MODULE crea una clase S4 de R.

obj = new(GradientDescentSumaCuadradosClase,A,y)

punto_inicial_alternativo = c(1,-1,-2,1)
obj$starting_point(punto_inicial_alternativo)

coefs2 = obj$solve()
names(coefs2)<-colnames(A)
coefs2

##       Interc  Sepal.Width Petal.Length  Petal.Width 
##    1.9291884    0.6326327    0.6991565   -0.5391704

lm(data=iris[,-5], formula=Sepal.Length~.)$coefficients

##  (Intercept)  Sepal.Width Petal.Length  Petal.Width 
##    1.8559975    0.6508372    0.7091320   -0.5564827

Purple como librería externa

• Ventaja: obtenemos la librería externa de su ubicación original (integración continua)
• Se enlaza al compilar el paquete referenciandola en en el Makevars (PKG_LIBS)

## -*- mode: makefile; -*-
PKG_CXXFLAGS=-I../../Purple
PKG_LIBS=-L../../lib -lPurple
## With R 3.1.0 or later, you can uncomment the following line to tell R to
## enable compilation with C++11 (where available)
CXX_STD = CXX11

• Previamente hay que compilar Purple. Es necesario? Recomendable para evitar problemas de compatibilidad con la tool-chain que compila los paquetes en R (sobre todo en Windows)
• Con ayuda del fichero Makefile (Makefile.win): make -f Makefile
• Disponible en VersionCompilacionExterna/

• A veces no recompila los archivos. Usar: devtools::clean_dll(); devtools::clean_source()
• Borrar los archivos R/RcppExport.R y src/RcppExport.cpp
• Si usamos roxygen2 revisar el NAMESPACE. Tiene que tener:

## # Generated by roxygen2: do not edit by hand
## 
## export(GradientDescentSumaCuadrados)
## export(GradientDescentSumaCuadradosClase)
## import(Rcpp)
## useDynLib(GradDesc)

• Si tenemos algún memory leak: R -f script_que_peta.R -d valgrind ref
• Si queremos debbugear con gdb: R --debugger=gdb ref
• Pedir socorro: Stackoverflow, lista Rcpp-devel, lista R-es.