[Rcpp-commits] r992 - pkg/RcppArmadillo

[noreply at r-forge.r-project.org]

Author: romain
Date: 2010-04-05 19:03:27 +0200 (Mon, 05 Apr 2010)
New Revision: 992

Added:
   pkg/RcppArmadillo/README
Log:
draft README

Added: pkg/RcppArmadillo/README
===================================================================
--- pkg/RcppArmadillo/README	                        (rev 0)
+++ pkg/RcppArmadillo/README	2010-04-05 17:03:27 UTC (rev 992)
@@ -0,0 +1,39 @@
+
+
+===== typical use =====
+
+to use RcppArmadillo, you need to create a package that : 
+
+- contains the following line in its DESCRIPTION file: 
+
+LinkingTo: RcppArmadillo
+
+- contains a src/Mavevars (and src/Makevars.win) with: 
+
+PKG_CXXFLAGS=$(shell Rscript -e "Rcpp:::CxxFlags()"|sed /^WARNING/d)
+PKG_LIBS=$(shell Rscript -e "Rcpp:::LdFlags()"|sed /^WARNING/d) $(LAPACK_LIBS) $(BLAS_LIBS) $(FLIBS)
+
+- include the RcppArmadillo header :
+
+#include <RcppArmadillo.h> 
+
+
+
+===== options : atlas and boost =====
+
+armadillo can optionally use atlas and boost. Please refer to the 
+armadillo documentation http://arma.sourceforge.net/
+
+RcppArmadillo does not force these features. it is up to the third party package 
+to enable these them for their package.
+
+If your package wants to make use of these features, you can add a subset of 
+these lines before #include <RcppArmadillo.h> 
+
+#define ARMA_USE_BOOST
+#define ARMA_USE_BOOST_DATE
+#define ARMA_USE_ATLAS
+
+when you do so, you must make sure that the corresponding features are 
+available, which typically involves writing a configure file. Refer to 
+Writing R Extensions for the procedure.