R: Thread options for RcppParallel

setThreadOptions {RcppParallel} | R Documentation

## Thread options for RcppParallel

### Description

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

### Usage

    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.

### Value

The `defaultNumThreads` returns the default number of threads that are used by RcppParallel if another value isn't specified using `setThreadOptions`.

### Examples

    ## Not run:
    library(RcppParallel)
    setThreadOptions(numThreads = 4)
    defaultNumThreads()

    ## End(Not run)

[Package RcppParallel version 5.0.0 Index]