naginterfaces.library.omp.in_parallel¶
- naginterfaces.library.omp.in_parallel()[source]¶
in_parallel
returns if called from within an active OpenMP parallel region, and otherwise.For full information please refer to the NAG Library document for x06af
https://support.nag.com/numeric/nl/nagdoc_30.3/flhtml/x06/x06aff.html
- Returns
- inparbool
if called from within an active OpenMP parallel region, and otherwise.
- Notes
in_parallel
, for multithreaded implementations, returns if called from within an active OpenMP parallel region, and otherwise.In serial implementations of the NAG Library this function will always return . See the X06 Introduction for a discussion of the behaviour of these functions when called in serial.
- References
The OpenMP API Specification for Parallel Programming
Chapman, B, Jost, G and van der Pas, R, 2008, Using OpenMP Portable Shared Memory Parallel Programming, The MIT Press