Skip to content

Support OpenMP #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eddelbuettel merged 9 commits into from
Dec 29, 2025
Merged

Support OpenMP #145

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
da9cb79
Add basic (unthrottled) OpenMP support
eddelbuettel Dec 27, 2025
c16052e
Refine init.R for core setting
eddelbuettel Dec 27, 2025
fd067a3
Simplify Makevars{,.win} removing comments, minor code cleanup
eddelbuettel Dec 28, 2025
d23115c
Add configure logic (relying on recent RcppArmadillo change)
eddelbuettel Dec 28, 2025
edfdfc7
Export and document threading helpers
eddelbuettel Dec 28, 2025
03f32db
Add package startup message, expand documentation
eddelbuettel Dec 28, 2025
2986c90
Minor documentation correction from code review [ci skip]
eddelbuettel Dec 28, 2025
efd64a6
Add ChangeLog entry
eddelbuettel Dec 28, 2025
4cac1ed
Set a distinct version number for the branch
eddelbuettel Dec 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Refine init.R for core setting
  • Loading branch information
@eddelbuettel
eddelbuettel committed Dec 27, 2025
commit c16052eab77e58751ed61a4ca66a26d12a0827ba
19 changes: 13 additions & 6 deletions R/init.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,27 @@
.pkgenv <- new.env(parent=emptyenv())

.onLoad <- function(libname, pkgname) {
.pkgenv[["nb_threads"]] <- EigenNbThreads() # #nocov
## 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 = 2) {
RcppEigen_throttle_cores <- function(n) {
if (missing(n)) n <- .pkgenv[["nb_threads"]]
EigenSetNbThreads(n)
}

##' @rdname RcppEigen_throttle_cores
eigen_reset_cores <- function() {
n <- .pkgenv[["nb_threads"]]
EigenSetNbThreads(n)
##'@ rdname RcppEigen_throttle_cores
RcppEigen_reset_cores <- function() {
EigenSetNbThreads(.pkgenv[["nb_threads"]])
}