NAG Library Manual, Mark 30.3
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG CL Interface Introduction
X06 (Omp) Chapter Contents
X06 (Omp) Chapter Introduction
x06af:  FL   CL   CPP   AD   PY   MB 

NAG CL Interface
x06afc (in_​parallel)

NAG Library Manual, Mark 30.3
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG CL Interface Introduction
X06 (Omp) Chapter Contents
X06 (Omp) Chapter Introduction
x06af:  FL   CL   CPP   AD   PY   MB 

▸▿ Contents

Copyright NAG 2024
Settings help

CL Name Style:


1 Purpose

x06afc returns 1 if called from within an active OpenMP parallel region, and 0 otherwise.

2 Specification

#include <nag.h>
Integer  x06afc ()
The function may be called by the names: x06afc or nag_omp_in_parallel.

3 Description

x06afc, for multithreaded implementations, returns 1 if called from within an active OpenMP parallel region, and 0 otherwise.
In serial implementations of the NAG Library this function will always return 0. See the X06 Chapter Introduction for a discussion of the behaviour of these functions when called in serial.

4 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

5 Arguments

None.

6 Error Indicators and Warnings

None.

7 Accuracy

Not applicable.

8 Parallelism and Performance

Background information to multithreading can be found in the Multithreading documentation.
x06afc is not threaded in any implementation.

9 Further Comments

None.

10 Example

See x06adc for a demonstration of how to use x06afc.
NAG Library Manual, Mark 30.3
Interfaces:  FL   CL   CPP   AD   PY   MB 
NAG CL Interface Introduction
X06 (Omp) Chapter Contents
X06 (Omp) Chapter Introduction
x06af:  FL   CL   CPP   AD   PY   MB 
Copyright NAG 2024