ATOMIC_005fDEFINE.html 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <!-- Copyright (C) 1999-2017 Free Software Foundation, Inc.
  4. Permission is granted to copy, distribute and/or modify this document
  5. under the terms of the GNU Free Documentation License, Version 1.3 or
  6. any later version published by the Free Software Foundation; with the
  7. Invariant Sections being "Funding Free Software", the Front-Cover
  8. Texts being (a) (see below), and with the Back-Cover Texts being (b)
  9. (see below). A copy of the license is included in the section entitled
  10. "GNU Free Documentation License".
  11. (a) The FSF's Front-Cover Text is:
  12. A GNU Manual
  13. (b) The FSF's Back-Cover Text is:
  14. You have freedom to copy and modify this GNU Manual, like GNU
  15. software. Copies published by the Free Software Foundation raise
  16. funds for GNU development. -->
  17. <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
  18. <head>
  19. <title>The GNU Fortran Compiler: ATOMIC_DEFINE</title>
  20. <meta name="description" content="The GNU Fortran Compiler: ATOMIC_DEFINE">
  21. <meta name="keywords" content="The GNU Fortran Compiler: ATOMIC_DEFINE">
  22. <meta name="resource-type" content="document">
  23. <meta name="distribution" content="global">
  24. <meta name="Generator" content="makeinfo">
  25. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  26. <link href="index.html#Top" rel="start" title="Top">
  27. <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
  28. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
  29. <link href="Intrinsic-Procedures.html#Intrinsic-Procedures" rel="up" title="Intrinsic Procedures">
  30. <link href="ATOMIC_005fFETCH_005fADD.html#ATOMIC_005fFETCH_005fADD" rel="next" title="ATOMIC_FETCH_ADD">
  31. <link href="ATOMIC_005fCAS.html#ATOMIC_005fCAS" rel="prev" title="ATOMIC_CAS">
  32. <style type="text/css">
  33. <!--
  34. a.summary-letter {text-decoration: none}
  35. blockquote.smallquotation {font-size: smaller}
  36. div.display {margin-left: 3.2em}
  37. div.example {margin-left: 3.2em}
  38. div.indentedblock {margin-left: 3.2em}
  39. div.lisp {margin-left: 3.2em}
  40. div.smalldisplay {margin-left: 3.2em}
  41. div.smallexample {margin-left: 3.2em}
  42. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
  43. div.smalllisp {margin-left: 3.2em}
  44. kbd {font-style:oblique}
  45. pre.display {font-family: inherit}
  46. pre.format {font-family: inherit}
  47. pre.menu-comment {font-family: serif}
  48. pre.menu-preformatted {font-family: serif}
  49. pre.smalldisplay {font-family: inherit; font-size: smaller}
  50. pre.smallexample {font-size: smaller}
  51. pre.smallformat {font-family: inherit; font-size: smaller}
  52. pre.smalllisp {font-size: smaller}
  53. span.nocodebreak {white-space:nowrap}
  54. span.nolinebreak {white-space:nowrap}
  55. span.roman {font-family:serif; font-weight:normal}
  56. span.sansserif {font-family:sans-serif; font-weight:normal}
  57. ul.no-bullet {list-style: none}
  58. -->
  59. </style>
  60. </head>
  61. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
  62. <a name="ATOMIC_005fDEFINE"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="ATOMIC_005fFETCH_005fADD.html#ATOMIC_005fFETCH_005fADD" accesskey="n" rel="next">ATOMIC_FETCH_ADD</a>, Previous: <a href="ATOMIC_005fCAS.html#ATOMIC_005fCAS" accesskey="p" rel="prev">ATOMIC_CAS</a>, Up: <a href="Intrinsic-Procedures.html#Intrinsic-Procedures" accesskey="u" rel="up">Intrinsic Procedures</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
  66. </div>
  67. <hr>
  68. <a name="ATOMIC_005fDEFINE-_002d_002d_002d-Setting-a-variable-atomically"></a>
  69. <h3 class="section">9.31 <code>ATOMIC_DEFINE</code> &mdash; Setting a variable atomically</h3>
  70. <a name="index-ATOMIC_005fDEFINE-1"></a>
  71. <a name="index-Atomic-subroutine_002c-define"></a>
  72. <dl compact="compact">
  73. <dt><em>Description</em>:</dt>
  74. <dd><p><code>ATOMIC_DEFINE(ATOM, VALUE)</code> defines the variable <var>ATOM</var> with the value
  75. <var>VALUE</var> atomically. When <var>STAT</var> is present and the invocation was
  76. successful, it is assigned the value 0. If it is present and the invocation
  77. has failed, it is assigned a positive value; in particular, for a coindexed
  78. <var>ATOM</var>, if the remote image has stopped, it is assigned the value of
  79. <code>ISO_FORTRAN_ENV</code>&rsquo;s <code>STAT_STOPPED_IMAGE</code> and if the remote image has
  80. failed, the value <code>STAT_FAILED_IMAGE</code>.
  81. </p>
  82. </dd>
  83. <dt><em>Standard</em>:</dt>
  84. <dd><p>Fortran 2008 and later; with <var>STAT</var>, TS 18508 or later
  85. </p>
  86. </dd>
  87. <dt><em>Class</em>:</dt>
  88. <dd><p>Atomic subroutine
  89. </p>
  90. </dd>
  91. <dt><em>Syntax</em>:</dt>
  92. <dd><p><code>CALL ATOMIC_DEFINE (ATOM, VALUE [, STAT])</code>
  93. </p>
  94. </dd>
  95. <dt><em>Arguments</em>:</dt>
  96. <dd><table>
  97. <tr><td width="15%"><var>ATOM</var></td><td width="70%">Scalar coarray or coindexed variable of either integer
  98. type with <code>ATOMIC_INT_KIND</code> kind or logical type with
  99. <code>ATOMIC_LOGICAL_KIND</code> kind.</td></tr>
  100. <tr><td width="15%"><var>VALUE</var></td><td width="70%">Scalar of the same type as <var>ATOM</var>. If the kind
  101. is different, the value is converted to the kind of <var>ATOM</var>.</td></tr>
  102. <tr><td width="15%"><var>STAT</var></td><td width="70%">(optional) Scalar default-kind integer variable.</td></tr>
  103. </table>
  104. </dd>
  105. <dt><em>Example</em>:</dt>
  106. <dd><div class="smallexample">
  107. <pre class="smallexample">program atomic
  108. use iso_fortran_env
  109. integer(atomic_int_kind) :: atom[*]
  110. call atomic_define (atom[1], this_image())
  111. end program atomic
  112. </pre></div>
  113. </dd>
  114. <dt><em>See also</em>:</dt>
  115. <dd><p><a href="ATOMIC_005fREF.html#ATOMIC_005fREF">ATOMIC_REF</a>, <a href="ATOMIC_005fCAS.html#ATOMIC_005fCAS">ATOMIC_CAS</a>, <a href="ISO_005fFORTRAN_005fENV.html#ISO_005fFORTRAN_005fENV">ISO_FORTRAN_ENV</a>,
  116. <a href="ATOMIC_005fADD.html#ATOMIC_005fADD">ATOMIC_ADD</a>, <a href="ATOMIC_005fAND.html#ATOMIC_005fAND">ATOMIC_AND</a>, <a href="ATOMIC_005fOR.html#ATOMIC_005fOR">ATOMIC_OR</a>, <a href="ATOMIC_005fXOR.html#ATOMIC_005fXOR">ATOMIC_XOR</a>
  117. </p></dd>
  118. </dl>
  119. </body>
  120. </html>