NUM_005fIMAGES.html 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146
  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: NUM_IMAGES</title>
  20. <meta name="description" content="The GNU Fortran Compiler: NUM_IMAGES">
  21. <meta name="keywords" content="The GNU Fortran Compiler: NUM_IMAGES">
  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="OR.html#OR" rel="next" title="OR">
  31. <link href="NULL.html#NULL" rel="prev" title="NULL">
  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="NUM_005fIMAGES"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="OR.html#OR" accesskey="n" rel="next">OR</a>, Previous: <a href="NULL.html#NULL" accesskey="p" rel="prev">NULL</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="NUM_005fIMAGES-_002d_002d_002d-Function-that-returns-the-number-of-images"></a>
  69. <h3 class="section">9.209 <code>NUM_IMAGES</code> &mdash; Function that returns the number of images</h3>
  70. <a name="index-NUM_005fIMAGES"></a>
  71. <a name="index-coarray_002c-NUM_005fIMAGES"></a>
  72. <a name="index-images_002c-number-of"></a>
  73. <dl compact="compact">
  74. <dt><em>Description</em>:</dt>
  75. <dd><p>Returns the number of images.
  76. </p>
  77. </dd>
  78. <dt><em>Standard</em>:</dt>
  79. <dd><p>Fortran 2008 and later. With <var>DISTANCE</var> or <var>FAILED</var> argument,
  80. Technical Specification (TS) 18508 or later
  81. </p>
  82. </dd>
  83. <dt><em>Class</em>:</dt>
  84. <dd><p>Transformational function
  85. </p>
  86. </dd>
  87. <dt><em>Syntax</em>:</dt>
  88. <dd><p><code>RESULT = NUM_IMAGES(DISTANCE, FAILED)</code>
  89. </p>
  90. </dd>
  91. <dt><em>Arguments</em>:</dt>
  92. <dd><table>
  93. <tr><td width="15%"><var>DISTANCE</var></td><td width="70%">(optional, intent(in)) Nonnegative scalar integer</td></tr>
  94. <tr><td width="15%"><var>FAILED</var></td><td width="70%">(optional, intent(in)) Scalar logical expression</td></tr>
  95. </table>
  96. </dd>
  97. <dt><em>Return value</em>:</dt>
  98. <dd><p>Scalar default-kind integer. If <var>DISTANCE</var> is not present or has value 0,
  99. the number of images in the current team is returned. For values smaller or
  100. equal distance to the initial team, it returns the number of images index
  101. on the ancestor team which has a distance of <var>DISTANCE</var> from the invoking
  102. team. If <var>DISTANCE</var> is larger than the distance to the initial team, the
  103. number of images of the initial team is returned. If <var>FAILED</var> is not present
  104. the total number of images is returned; if it has the value <code>.TRUE.</code>,
  105. the number of failed images is returned, otherwise, the number of images which
  106. do have not the failed status.
  107. </p>
  108. </dd>
  109. <dt><em>Example</em>:</dt>
  110. <dd><div class="smallexample">
  111. <pre class="smallexample">INTEGER :: value[*]
  112. INTEGER :: i
  113. value = THIS_IMAGE()
  114. SYNC ALL
  115. IF (THIS_IMAGE() == 1) THEN
  116. DO i = 1, NUM_IMAGES()
  117. WRITE(*,'(2(a,i0))') 'value[', i, '] is ', value[i]
  118. END DO
  119. END IF
  120. </pre></div>
  121. </dd>
  122. <dt><em>See also</em>:</dt>
  123. <dd><p><a href="THIS_005fIMAGE.html#THIS_005fIMAGE">THIS_IMAGE</a>, <a href="IMAGE_005fINDEX.html#IMAGE_005fINDEX">IMAGE_INDEX</a>
  124. </p></dd>
  125. </dl>
  126. </body>
  127. </html>