setThreadOptions: Thread options for RcppParallel

Description Usage Arguments Details Value Examples

View source: R/options.R

Description

Set thread options (number of threads to use for task scheduling and stack size per-thread) for RcppParallel.

Usage

1
2
3
setThreadOptions(numThreads = "auto", stackSize = "auto")

defaultNumThreads()

Arguments

numThreads

Number of threads to use for task scheduling. Call defaultNumThreads() to determine the the default value used for "auto".

stackSize

Stack size (in bytes) to use for worker threads. The default used for "auto" is 2MB on 32-bit systems and 4MB on 64-bit systems (note that this parameter has no effect on Windows).

Details

RcppParallel is automatically initialized with the default number of threads and thread stack size when it loads. You can call setThreadOptions() at any time to change the defaults.

The parallelFor() and parallelReduce() also accept numThreads as an argument, if you'd like to control the number of threads specifically to be made available for a particular parallel function call. Note that this value is advisory, and TBB may choose a smaller number of threads if the number of requested threads cannot be honored on the system.

Value

defaultNumThreads() returns the default number of threads used by RcppParallel, if another value isn't specified either via setThreadOptions() or explicitly in calls to parallelFor() and parallelReduce().

Examples

1
2
3
4
5
6
## Not run: 
library(RcppParallel)
setThreadOptions(numThreads = 4)
defaultNumThreads()

## End(Not run)

RcppParallel documentation built on May 4, 2021, 9:06 a.m.