[thirdparty/gcc.git] / libgomp / doc / openmp-runtime-library-routines / ompgetmaxteams.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. _omp_get_max_teams:

omp_get_max_teams -- Maximum number of teams of teams region
************************************************************

Description:
  Return the maximum number of teams used for the teams region
  that does not use the clause ``num_teams``.

C/C++:
  .. list-table::

     * - *Prototype*:
       - ``int omp_get_max_teams(void);``

Fortran:
  .. list-table::

     * - *Interface*:
       - ``integer function omp_get_max_teams()``

See also:
  :ref:`omp_set_num_teams`, :ref:`omp_get_num_teams`

Reference:
  :openmp:`5.1`, Section 3.4.4.
Commit	Line	Data
c63539ff ML	1	..
	2	Copyright 1988-2022 Free Software Foundation, Inc.
	3	This is part of the GCC manual.
	4	For copying conditions, see the copyright.rst file.
	5
	6	.. _omp_get_max_teams:
	7
	8	omp_get_max_teams -- Maximum number of teams of teams region
	9	************************************************************
	10
	11	Description:
	12	Return the maximum number of teams used for the teams region
	13	that does not use the clause ``num_teams``.
	14
	15	C/C++:
	16	.. list-table::
	17
	18	* - Prototype:
	19	- ``int omp_get_max_teams(void);``
	20
	21	Fortran:
	22	.. list-table::
	23
	24	* - Interface:
	25	- ``integer function omp_get_max_teams()``
	26
	27	See also:
	28	:ref:`omp_set_num_teams`, :ref:`omp_get_num_teams`
	29
	30	Reference:
3ed1b4ce	31	:openmp:`5.1`, Section 3.4.4.