File: imxGetNumThreads.Rd

package info (click to toggle)
r-cran-openmx 2.21.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 14,412 kB
  • sloc: cpp: 36,577; ansic: 13,811; fortran: 2,001; sh: 1,440; python: 350; perl: 21; makefile: 5
file content (20 lines) | stat: -rw-r--r-- 699 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
\name{imxGetNumThreads}
\alias{imxGetNumThreads}
\title{imxGetNumThreads}
\usage{
imxGetNumThreads()
}
\description{
This is an internal function exported for those people who know
what they are doing.

This function hard codes responses to a set of environments, like detecting snowfall,
or running on a cluster where "OMP_NUM_THREADS" is set or otherwise returning 1 or 2 cores
to avoid consuming all the resources on CRAN's test machines during release cycles.

This makes it \emph{not} suitable for getting the number of available threads.

To get the number of cores available locally you want \code{\link{omxDetectCores}}
or perhaps the \code{detectCores} function in the parallel package.

}