Support OpenMP

R/RcppExports.R

@@ -5,6 +5,10 @@ eigen_version <- function(single) {
     .Call(`_RcppEigen_eigen_version`, single)
 }
 
+eigen_version_typed <- function() {
+    .Call(`_RcppEigen_eigen_version_typed`)
+}
+
 Eigen_SSE <- function() {
     .Call(`_RcppEigen_Eigen_SSE`)
 }
@@ -13,6 +17,10 @@ EigenNbThreads <- function() {
     .Call(`_RcppEigen_EigenNbThreads`)
 }
 
+EigenSetNbThreads <- function(n) {
+    invisible(.Call(`_RcppEigen_EigenSetNbThreads`, n))
+}
+
 fastLm_Impl <- function(X, y, type) {
     .Call(`_RcppEigen_fastLm_Impl`, X, y, type)
 }

R/init.R

@@ -0,0 +1,46 @@
+## init.R: Startup
+##
+## Copyright (C)  2025  Dirk Eddelbuettel
+##
+## This file is part of RcppEigen.
+##
+## RcppEigen is free software: you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation, either version 2 of the License, or
+## (at your option) any later version.
+##
+## RcppEigen is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with RcppEigen.  If not, see <http://www.gnu.org/licenses/>.
+
+.pkgenv <- new.env(parent=emptyenv())
+
+.onLoad <- function(libname, pkgname) {
+    ## simple fallback: 'Ncpus' (if set) or else all cpus seen by OpenMP
+    ncores <- getOption("Ncpus", EigenNbThreads())
+    ## consider OMP_THREAD_LIMIT (cf Writing R Extensions), gets NA if envvar unset
+    ompcores <- as.integer(Sys.getenv("OMP_THREAD_LIMIT"))
+    ## keep the smaller value, omitting NA
+    ncores <- min(na.omit(c(ncores, ompcores)))
+    .pkgenv[["nb_threads"]] <- ncores		# #nocov
+    RcppEigen_throttle_cores(ncores)
+}
+
+##' Throttle (or Reset) (Rcpp)Eigen to Two Cores
+##'
+##' Helper functions to throttle use of cores by RcppEigen-internal code.
+##' On package load, the initial value is saved and used to reset the value.
+##' @param n Integer value of desired cores, default is two
+RcppEigen_throttle_cores <- function(n) {
+    if (missing(n)) n <- .pkgenv[["nb_threads"]]
+    EigenSetNbThreads(n)
+}
+
+##'@ rdname RcppEigen_throttle_cores
+RcppEigen_reset_cores <- function() {
+    EigenSetNbThreads(.pkgenv[["nb_threads"]])
+}

cleanup

@@ -4,5 +4,6 @@ rm -f  src/*.o src/*.so \
        inst/doc/RcppEigen-unitTests.out \
        inst/doc/RcppEigen-unitTests.aux \
        inst/doc/RcppEigen-unitTests.log \
-       */*~ *~
+       */*~ *~ \
+       config.log config.status src/Makevars
 rm -rf autom4te.cache