RcppArmadillo-package

RcppArmadillo

RcppArmadilloExample

The package brings the power of Armadillo to R.

package

programming

interface

'Armadillo' is a templated C++ linear algebra library aiming towards
a good balance between speed and ease of use. It provides high-level syntax and
functionality deliberately similar to Matlab. It is useful for algorithm development
directly in C++, or quick conversion of research code into production environments.
It provides efficient classes for vectors, matrices and cubes where dense and sparse
matrices are supported. Integer, floating point and complex numbers are supported.
A sophisticated expression evaluator (based on template meta-programming) automatically
combines several operations to increase speed and efficiency. Dynamic evaluation
automatically chooses optimal code paths based on detected matrix structures.
Matrix decompositions are provided through integration with LAPACK, or one of its
high performance drop-in replacements (such as 'MKL' or 'OpenBLAS'). It can
automatically use 'OpenMP' multi-threading (parallelisation) to speed up
computationally expensive operations.

The 'RcppArmadillo' package includes the header files from the 'Armadillo' library;
users do not need to install 'Armadillo' itself in order to use 'RcppArmadillo'.
Starting from release 15.0.0, the minimum compilation standard is C++14 so 'Armadillo'
version 14.6.3 is included as a fallback when an R package forces the C++11 standard.
Package authors should set a '#define' to select the 'current' version, or select the
'legacy' version (also chosen as default) if they must. See 'GitHub issue #475' for
details.

Since release 7.800.0, 'Armadillo' is licensed under Apache License 2; previous
releases were under licensed as MPL 2.0 from version 3.800.0 onwards and LGPL-3
prior to that; 'RcppArmadillo' (the 'Rcpp' bindings/bridge to Armadillo) is licensed
under the GNU GPL version 2 or later, as is the rest of 'Rcpp'.

Dirk Eddelbuettel

'Rcpp' Integration for the 'Armadillo' Templated Linear Algebra
Library

Romain Francois

Doug Bates

Binxiang Ni

Conrad Sanderson

RcppArmadillo-package function

<code>Armadillo</code> is a C++ linear algebra library, aiming towards a good
 balance between speed and ease of use.
It provides efficient classes for vectors, matrices and cubes, as well
 as many functions which operate on the classes (eg. contiguous and
 non-contiguous submatrix views).
Various matrix decompositions are provided, and an automatic
 expression evaluator (via template meta-programming) combines several
 operations to increase efficiency.
The syntax (API) is deliberately similar to Matlab. It is useful for
 algorithm development directly in C++, or quick conversion of research
 code into production environments.
Armadillo has been primarily developed at NICTA (Australia) by Conrad
 Sanderson, with contributions from around the world.

Armadillo

<code>RcppArmadillo</code> acts as a bridge between <code>Rcpp</code> and <code>Armadillo</code>,
 allowing the programmer to write code using Armadillo classes that integrate
 seemlessly with <code>R</code> via <code>Rcpp</code>.

The simplest way to get started is to create a skeleton of a package
 using <code>RcppArmadillo</code>. This can be done conveniently by the
 <code>RcppArmadillo.package.skeleton</code>
 function.

Using RcppArmadillo

The Armadillo library can take advantage of OpenMP to execute computations in
 parallel via multi-threaded code. The number of cores uses can be set (or
 retrieved) explicitly via helper functions <code>armadillo_get_number_of_omp+threads()</code> and
 <code>armadillo_set_number_of_omp_threads()</code>. A default value is stored at package startup; it
 recognises R option value <code>Ncpus</code> and environment variable
 <code>OMP_THREAD_LIMIT</code>. Additional helper functions
 <code>armadillo_throttle_cores()</code> and <code>armadillo_reset_cores()</code> are
 available to (temporarily) lower the number of cores uses and to reset to
 the package default value set at startup.

Threading

For RcppArmadillo: Dirk Eddelbuettel, Romain Francois, Doug Bates and
 Binxiang Ni
Maintainer: Dirk Eddelbuettel &lt;edd@debian.org&gt;
For Armadillo: Conrad Sanderson

RcppArmadillo-package: R and Armadillo Integration

Description

Arguments

Armadillo

RcppArmadillo

Using RcppArmadillo

Threading

Author

References