| <html lang="en"> |
| <head> |
| <title>UNPACK - The GNU Fortran Compiler</title> |
| <meta http-equiv="Content-Type" content="text/html"> |
| <meta name="description" content="The GNU Fortran Compiler"> |
| <meta name="generator" content="makeinfo 4.13"> |
| <link title="Top" rel="start" href="index.html#Top"> |
| <link rel="up" href="Intrinsic-Procedures.html#Intrinsic-Procedures" title="Intrinsic Procedures"> |
| <link rel="prev" href="UNLINK.html#UNLINK" title="UNLINK"> |
| <link rel="next" href="VERIFY.html#VERIFY" title="VERIFY"> |
| <link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage"> |
| <!-- |
| Copyright (C) 1999-2013 Free Software Foundation, Inc. |
| |
| Permission is granted to copy, distribute and/or modify this document |
| under the terms of the GNU Free Documentation License, Version 1.3 or |
| any later version published by the Free Software Foundation; with the |
| Invariant Sections being ``Funding Free Software'', the Front-Cover |
| Texts being (a) (see below), and with the Back-Cover Texts being (b) |
| (see below). A copy of the license is included in the section entitled |
| ``GNU Free Documentation License''. |
| |
| (a) The FSF's Front-Cover Text is: |
| |
| A GNU Manual |
| |
| (b) The FSF's Back-Cover Text is: |
| |
| You have freedom to copy and modify this GNU Manual, like GNU |
| software. Copies published by the Free Software Foundation raise |
| funds for GNU development.--> |
| <meta http-equiv="Content-Style-Type" content="text/css"> |
| <style type="text/css"><!-- |
| pre.display { font-family:inherit } |
| pre.format { font-family:inherit } |
| pre.smalldisplay { font-family:inherit; font-size:smaller } |
| pre.smallformat { font-family:inherit; font-size:smaller } |
| pre.smallexample { font-size:smaller } |
| pre.smalllisp { font-size:smaller } |
| span.sc { font-variant:small-caps } |
| span.roman { font-family:serif; font-weight:normal; } |
| span.sansserif { font-family:sans-serif; font-weight:normal; } |
| --></style> |
| </head> |
| <body> |
| <div class="node"> |
| <a name="UNPACK"></a> |
| <p> |
| Next: <a rel="next" accesskey="n" href="VERIFY.html#VERIFY">VERIFY</a>, |
| Previous: <a rel="previous" accesskey="p" href="UNLINK.html#UNLINK">UNLINK</a>, |
| Up: <a rel="up" accesskey="u" href="Intrinsic-Procedures.html#Intrinsic-Procedures">Intrinsic Procedures</a> |
| <hr> |
| </div> |
| |
| <h3 class="section">8.255 <code>UNPACK</code> — Unpack an array of rank one into an array</h3> |
| |
| <p><a name="index-UNPACK-1131"></a><a name="index-array_002c-unpacking-1132"></a><a name="index-array_002c-increase-dimension-1133"></a><a name="index-array_002c-scatter-elements-1134"></a> |
| <dl> |
| <dt><em>Description</em>:<dd>Store the elements of <var>VECTOR</var> in an array of higher rank. |
| |
| <br><dt><em>Standard</em>:<dd>Fortran 95 and later |
| |
| <br><dt><em>Class</em>:<dd>Transformational function |
| |
| <br><dt><em>Syntax</em>:<dd><code>RESULT = UNPACK(VECTOR, MASK, FIELD)</code> |
| |
| <br><dt><em>Arguments</em>:<dd> |
| <p><table summary=""><tr align="left"><td valign="top" width="15%"><var>VECTOR</var> </td><td valign="top" width="70%">Shall be an array of any type and rank one. It |
| shall have at least as many elements as <var>MASK</var> has <code>TRUE</code> values. |
| <br></td></tr><tr align="left"><td valign="top" width="15%"><var>MASK</var> </td><td valign="top" width="70%">Shall be an array of type <code>LOGICAL</code>. |
| <br></td></tr><tr align="left"><td valign="top" width="15%"><var>FIELD</var> </td><td valign="top" width="70%">Shall be of the same type as <var>VECTOR</var> and have |
| the same shape as <var>MASK</var>. |
| <br></td></tr></table> |
| |
| <br><dt><em>Return value</em>:<dd>The resulting array corresponds to <var>FIELD</var> with <code>TRUE</code> elements |
| of <var>MASK</var> replaced by values from <var>VECTOR</var> in array element order. |
| |
| <br><dt><em>Example</em>:<dd> |
| <pre class="smallexample"> PROGRAM test_unpack |
| integer :: vector(2) = (/1,1/) |
| logical :: mask(4) = (/ .TRUE., .FALSE., .FALSE., .TRUE. /) |
| integer :: field(2,2) = 0, unity(2,2) |
| |
| ! result: unity matrix |
| unity = unpack(vector, reshape(mask, (/2,2/)), field) |
| END PROGRAM |
| </pre> |
| <br><dt><em>See also</em>:<dd><a href="PACK.html#PACK">PACK</a>, <a href="SPREAD.html#SPREAD">SPREAD</a> |
| </dl> |
| |
| </body></html> |
| |
