CO_005fREDUCE.html 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174
  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: CO_REDUCE</title>
  20. <meta name="description" content="The GNU Fortran Compiler: CO_REDUCE">
  21. <meta name="keywords" content="The GNU Fortran Compiler: CO_REDUCE">
  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="CO_005fSUM.html#CO_005fSUM" rel="next" title="CO_SUM">
  31. <link href="CO_005fMIN.html#CO_005fMIN" rel="prev" title="CO_MIN">
  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="CO_005fREDUCE"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="CO_005fSUM.html#CO_005fSUM" accesskey="n" rel="next">CO_SUM</a>, Previous: <a href="CO_005fMIN.html#CO_005fMIN" accesskey="p" rel="prev">CO_MIN</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="CO_005fREDUCE-_002d_002d_002d-Reduction-of-values-on-the-current-set-of-images"></a>
  69. <h3 class="section">9.66 <code>CO_REDUCE</code> &mdash; Reduction of values on the current set of images</h3>
  70. <a name="index-CO_005fREDUCE"></a>
  71. <a name="index-Collectives_002c-generic-reduction"></a>
  72. <dl compact="compact">
  73. <dt><em>Description</em>:</dt>
  74. <dd><p><code>CO_REDUCE</code> determines element-wise the reduction of the value of <var>A</var>
  75. on all images of the current team. The pure function passed as <var>OPERATOR</var>
  76. is used to pairwise reduce the values of <var>A</var> by passing either the value
  77. of <var>A</var> of different images or the result values of such a reduction as
  78. argument. If <var>A</var> is an array, the deduction is done element wise. If
  79. <var>RESULT_IMAGE</var> is present, the result values are returned in <var>A</var> on
  80. the specified image only and the value of <var>A</var> on the other images become
  81. undefined. If <var>RESULT_IMAGE</var> is not present, the value is returned on all
  82. images. If the execution was successful and <var>STAT</var> is present, it is
  83. assigned the value zero. If the execution failed, <var>STAT</var> gets assigned
  84. a nonzero value and, if present, <var>ERRMSG</var> gets assigned a value describing
  85. the occurred error.
  86. </p>
  87. </dd>
  88. <dt><em>Standard</em>:</dt>
  89. <dd><p>Technical Specification (TS) 18508 or later
  90. </p>
  91. </dd>
  92. <dt><em>Class</em>:</dt>
  93. <dd><p>Collective subroutine
  94. </p>
  95. </dd>
  96. <dt><em>Syntax</em>:</dt>
  97. <dd><p><code>CALL CO_REDUCE(A, OPERATOR, [, RESULT_IMAGE, STAT, ERRMSG])</code>
  98. </p>
  99. </dd>
  100. <dt><em>Arguments</em>:</dt>
  101. <dd><table>
  102. <tr><td width="15%"><var>A</var></td><td width="70%">is an <code>INTENT(INOUT)</code> argument and shall be
  103. nonpolymorphic. If it is allocatable, it shall be allocated; if it is a pointer,
  104. it shall be associated. <var>A</var> shall have the same type and type parameters on
  105. all images of the team; if it is an array, it shall have the same shape on all
  106. images.</td></tr>
  107. <tr><td width="15%"><var>OPERATOR</var></td><td width="70%">pure function with two scalar nonallocatable
  108. arguments, which shall be nonpolymorphic and have the same type and type
  109. parameters as <var>A</var>. The function shall return a nonallocatable scalar of
  110. the same type and type parameters as <var>A</var>. The function shall be the same on
  111. all images and with regards to the arguments mathematically commutative and
  112. associative. Note that <var>OPERATOR</var> may not be an elemental function, unless
  113. it is an intrisic function.</td></tr>
  114. <tr><td width="15%"><var>RESULT_IMAGE</var></td><td width="70%">(optional) a scalar integer expression; if
  115. present, it shall have the same the same value on all images and refer to an
  116. image of the current team.</td></tr>
  117. <tr><td width="15%"><var>STAT</var></td><td width="70%">(optional) a scalar integer variable</td></tr>
  118. <tr><td width="15%"><var>ERRMSG</var></td><td width="70%">(optional) a scalar character variable</td></tr>
  119. </table>
  120. </dd>
  121. <dt><em>Example</em>:</dt>
  122. <dd><div class="smallexample">
  123. <pre class="smallexample">program test
  124. integer :: val
  125. val = this_image ()
  126. call co_reduce (val, result_image=1, operator=myprod)
  127. if (this_image() == 1) then
  128. write(*,*) &quot;Product value&quot;, val ! prints num_images() factorial
  129. end if
  130. contains
  131. pure function myprod(a, b)
  132. integer, value :: a, b
  133. integer :: myprod
  134. myprod = a * b
  135. end function myprod
  136. end program test
  137. </pre></div>
  138. </dd>
  139. <dt><em>Note</em>:</dt>
  140. <dd><p>While the rules permit in principle an intrinsic function, none of the
  141. intrinsics in the standard fulfill the criteria of having a specific
  142. function, which takes two arguments of the same type and returning that
  143. type as result.
  144. </p>
  145. </dd>
  146. <dt><em>See also</em>:</dt>
  147. <dd><p><a href="CO_005fMIN.html#CO_005fMIN">CO_MIN</a>, <a href="CO_005fMAX.html#CO_005fMAX">CO_MAX</a>, <a href="CO_005fSUM.html#CO_005fSUM">CO_SUM</a>, <a href="CO_005fBROADCAST.html#CO_005fBROADCAST">CO_BROADCAST</a>
  148. </p></dd>
  149. </dl>
  150. <hr>
  151. <div class="header">
  152. <p>
  153. Next: <a href="CO_005fSUM.html#CO_005fSUM" accesskey="n" rel="next">CO_SUM</a>, Previous: <a href="CO_005fMIN.html#CO_005fMIN" accesskey="p" rel="prev">CO_MIN</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>
  154. </div>
  155. </body>
  156. </html>