setCores {spMC} | R Documentation |
Set the number of CPU cores for HPC
Description
The function set the number of CPU cores for parallel computation by the use of OpenMP library (https://www.openmp.org/). If the package was not complied with the library OpenMP (>= 3.0), this function is disabled.
Usage
setCores(n)
Arguments
n |
an integer value denoting the number of CPU cores to use; if it exceeds the total number of cores, all of them will be used. If missing, the number of CPU cores in use will be displayed. |
Details
When the package is loaded, only one CPU core is used.
Value
The total number of CPU cores in use will be returned and a message will be displayed. If the package was not complied with the library OpenMP (>= 3.0), the value one will be returned.
Author(s)
Luca Sartore drwolf85@gmail.com
References
SunTM ONE Studio 8 (2003) OpenMP API User's Guide. Sun Microsystems Inc., Santa Clara, U.S.A.
Examples
#Display the number of CPU cores in use
setCores()
#Set 2 CPU cores for parallel computation
setCores(2)
#Set 1 CPU core for serial computation
setCores(1)