UNPACK.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  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: UNPACK</title>
  20. <meta name="description" content="The GNU Fortran Compiler: UNPACK">
  21. <meta name="keywords" content="The GNU Fortran Compiler: UNPACK">
  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="VERIFY.html#VERIFY" rel="next" title="VERIFY">
  31. <link href="UNLINK.html#UNLINK" rel="prev" title="UNLINK">
  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="UNPACK"></a>
  63. <div class="header">
  64. <p>
  65. Next: <a href="VERIFY.html#VERIFY" accesskey="n" rel="next">VERIFY</a>, Previous: <a href="UNLINK.html#UNLINK" accesskey="p" rel="prev">UNLINK</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="UNPACK-_002d_002d_002d-Unpack-an-array-of-rank-one-into-an-array"></a>
  69. <h3 class="section">9.279 <code>UNPACK</code> &mdash; Unpack an array of rank one into an array</h3>
  70. <a name="index-UNPACK"></a>
  71. <a name="index-array_002c-unpacking"></a>
  72. <a name="index-array_002c-increase-dimension-1"></a>
  73. <a name="index-array_002c-scatter-elements"></a>
  74. <dl compact="compact">
  75. <dt><em>Description</em>:</dt>
  76. <dd><p>Store the elements of <var>VECTOR</var> in an array of higher rank.
  77. </p>
  78. </dd>
  79. <dt><em>Standard</em>:</dt>
  80. <dd><p>Fortran 95 and 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 = UNPACK(VECTOR, MASK, FIELD)</code>
  89. </p>
  90. </dd>
  91. <dt><em>Arguments</em>:</dt>
  92. <dd><table>
  93. <tr><td width="15%"><var>VECTOR</var></td><td width="70%">Shall be an array of any type and rank one. It
  94. shall have at least as many elements as <var>MASK</var> has <code>TRUE</code> values.</td></tr>
  95. <tr><td width="15%"><var>MASK</var></td><td width="70%">Shall be an array of type <code>LOGICAL</code>.</td></tr>
  96. <tr><td width="15%"><var>FIELD</var></td><td width="70%">Shall be of the same type as <var>VECTOR</var> and have
  97. the same shape as <var>MASK</var>.</td></tr>
  98. </table>
  99. </dd>
  100. <dt><em>Return value</em>:</dt>
  101. <dd><p>The resulting array corresponds to <var>FIELD</var> with <code>TRUE</code> elements
  102. of <var>MASK</var> replaced by values from <var>VECTOR</var> in array element order.
  103. </p>
  104. </dd>
  105. <dt><em>Example</em>:</dt>
  106. <dd><div class="smallexample">
  107. <pre class="smallexample">PROGRAM test_unpack
  108. integer :: vector(2) = (/1,1/)
  109. logical :: mask(4) = (/ .TRUE., .FALSE., .FALSE., .TRUE. /)
  110. integer :: field(2,2) = 0, unity(2,2)
  111. ! result: unity matrix
  112. unity = unpack(vector, reshape(mask, (/2,2/)), field)
  113. END PROGRAM
  114. </pre></div>
  115. </dd>
  116. <dt><em>See also</em>:</dt>
  117. <dd><p><a href="PACK.html#PACK">PACK</a>, <a href="SPREAD.html#SPREAD">SPREAD</a>
  118. </p></dd>
  119. </dl>
  120. </body>
  121. </html>