hide long namesshow long names
hide short namesshow short names
Integer type:  int32  int64  nag_int  show int32  show int32  show int64  show int64  show nag_int  show nag_int

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

NAG Toolbox: nag_omp_get_max_threads (x06ac)

 Contents

    1  Purpose
    2  Syntax
    7  Accuracy
    9  Example

Purpose

nag_omp_get_max_threads (x06ac) returns the number of threads that will be used in subsequent multi-threaded NAG routines.

Syntax

[result] = x06ac
[result] = nag_omp_get_max_threads

Description

nag_omp_get_max_threads (x06ac), for multi-threaded implementations, returns the number of the threads that will be used in subsequent multi-threaded NAG Toolbox routines. Please see Multi-threaded Functions for a description of multi-threading in the NAG Toolbox.
In serial implementations of the NAG Toolbox this function will always return 1.

References

None.

Parameters

Compulsory Input Parameters

None.

Optional Input Parameters

None.

Output Parameters

1:     result int64int32nag_int scalar

Error Indicators and Warnings

None.

Accuracy

Not applicable.

Further Comments

None.

Example

See Example in nag_omp_set_num_threads (x06aa) for a demonstration of how to use nag_omp_get_max_threads (x06ac).

PDF version (NAG web site, 64-bit version, 64-bit version)
Chapter Contents
Chapter Introduction
NAG Toolbox

© The Numerical Algorithms Group Ltd, Oxford, UK. 2009–2015