THIS_005fIMAGE.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  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: THIS_IMAGE</title>
  20. <meta name="description" content="The GNU Fortran Compiler: THIS_IMAGE">
  21. <meta name="keywords" content="The GNU Fortran Compiler: THIS_IMAGE">
  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="TIME.html#TIME" rel="next" title="TIME">
  31. <link href="TANH.html#TANH" rel="prev" title="TANH">
  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="THIS_005fIMAGE"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="TIME.html#TIME" accesskey="n" rel="next">TIME</a>, Previous: <a href="TANH.html#TANH" accesskey="p" rel="prev">TANH</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="THIS_005fIMAGE-_002d_002d_002d-Function-that-returns-the-cosubscript-index-of-this-image"></a>
  69. <h3 class="section">9.266 <code>THIS_IMAGE</code> &mdash; Function that returns the cosubscript index of this image</h3>
  70. <a name="index-THIS_005fIMAGE"></a>
  71. <a name="index-coarray_002c-THIS_005fIMAGE"></a>
  72. <a name="index-images_002c-index-of-this-image"></a>
  73. <dl compact="compact">
  74. <dt><em>Description</em>:</dt>
  75. <dd><p>Returns the cosubscript for this image.
  76. </p>
  77. </dd>
  78. <dt><em>Standard</em>:</dt>
  79. <dd><p>Fortran 2008 and later. With <var>DISTANCE</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><table>
  89. <tr><td width="80%"><code>RESULT = THIS_IMAGE()</code></td></tr>
  90. <tr><td width="80%"><code>RESULT = THIS_IMAGE(DISTANCE)</code></td></tr>
  91. <tr><td width="80%"><code>RESULT = THIS_IMAGE(COARRAY [, DIM])</code></td></tr>
  92. </table>
  93. </dd>
  94. <dt><em>Arguments</em>:</dt>
  95. <dd><table>
  96. <tr><td width="15%"><var>DISTANCE</var></td><td width="70%">(optional, intent(in)) Nonnegative scalar integer
  97. (not permitted together with <var>COARRAY</var>).</td></tr>
  98. <tr><td width="15%"><var>COARRAY</var></td><td width="70%">Coarray of any type (optional; if <var>DIM</var>
  99. present, required).</td></tr>
  100. <tr><td width="15%"><var>DIM</var></td><td width="70%">default integer scalar (optional). If present,
  101. <var>DIM</var> shall be between one and the corank of <var>COARRAY</var>.</td></tr>
  102. </table>
  103. </dd>
  104. <dt><em>Return value</em>:</dt>
  105. <dd><p>Default integer. If <var>COARRAY</var> is not present, it is scalar; if
  106. <var>DISTANCE</var> is not present or has value 0, its value is the image index on
  107. the invoking image for the current team, for values smaller or equal
  108. distance to the initial team, it returns the image index on the ancestor team
  109. which has a distance of <var>DISTANCE</var> from the invoking team. If
  110. <var>DISTANCE</var> is larger than the distance to the initial team, the image
  111. index of the initial team is returned. Otherwise when the <var>COARRAY</var> is
  112. present, if <var>DIM</var> is not present, a rank-1 array with corank elements is
  113. returned, containing the cosubscripts for <var>COARRAY</var> specifying the invoking
  114. image. If <var>DIM</var> is present, a scalar is returned, with the value of
  115. the <var>DIM</var> element of <code>THIS_IMAGE(COARRAY)</code>.
  116. </p>
  117. </dd>
  118. <dt><em>Example</em>:</dt>
  119. <dd><div class="smallexample">
  120. <pre class="smallexample">INTEGER :: value[*]
  121. INTEGER :: i
  122. value = THIS_IMAGE()
  123. SYNC ALL
  124. IF (THIS_IMAGE() == 1) THEN
  125. DO i = 1, NUM_IMAGES()
  126. WRITE(*,'(2(a,i0))') 'value[', i, '] is ', value[i]
  127. END DO
  128. END IF
  129. ! Check whether the current image is the initial image
  130. IF (THIS_IMAGE(HUGE(1)) /= THIS_IMAGE())
  131. error stop &quot;something is rotten here&quot;
  132. </pre></div>
  133. </dd>
  134. <dt><em>See also</em>:</dt>
  135. <dd><p><a href="NUM_005fIMAGES.html#NUM_005fIMAGES">NUM_IMAGES</a>, <a href="IMAGE_005fINDEX.html#IMAGE_005fINDEX">IMAGE_INDEX</a>
  136. </p></dd>
  137. </dl>
  138. <hr>
  139. <div class="header">
  140. <p>
  141. Next: <a href="TIME.html#TIME" accesskey="n" rel="next">TIME</a>, Previous: <a href="TANH.html#TANH" accesskey="p" rel="prev">TANH</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>
  142. </div>
  143. </body>
  144. </html>