set_num_threads: Set the number of OpenMP threads used by the functions of...

Description Usage Arguments Value See Also Examples

Description

This function sets the value of the global variable stored in options()$cpgen.threads to the assigned integer. Note_1: The assigned value may exceed the number of physical cores present but that might lead to dramatical decrease in performance. Note_2: The function can override the global variable 'OMP_NUM_THREADS' (if global=TRUE and hence also other non-cpgen functions are affected by a call to set_num_threads().

Usage

1
set_num_threads(x,silent=FALSE, global=FALSE)

Arguments

x

Integer scalar that specifies the number of threads to be used by cpgen-functions

silent

boolean, controls whether to print a message

global

boolean, change openmp threads globally (might effect other libraries)

Value

Changes the global variable cpgen.threads to the value in x

See Also

get_num_threads, get_max_threads, check_openmp

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Control the number of threads being used in an R-session:

# set the number of threads to 1
## Not run: 
set_num_threads(1)

#### Use a parallelized cpgen-function

# generate random data
rand_data(1000,10000)

# check single-threaded performance
system.time(W <- M%c%t(M))

# set number of threads to 2

set_num_threads(2)

# check multi-threaded performance
system.time(W <- M%c%t(M))

## End(Not run)


Search within the cpgen package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.