blob: dc42bd33e949497eb700249892bb0e43bd8c6444 [file]
<html lang="en">
<head>
<title>PARITY - 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="PACK.html#PACK" title="PACK">
<link rel="next" href="PERROR.html#PERROR" title="PERROR">
<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="PARITY"></a>
<p>
Next:&nbsp;<a rel="next" accesskey="n" href="PERROR.html#PERROR">PERROR</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="PACK.html#PACK">PACK</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Intrinsic-Procedures.html#Intrinsic-Procedures">Intrinsic Procedures</a>
<hr>
</div>
<h3 class="section">8.190 <code>PARITY</code> &mdash; Reduction with exclusive OR</h3>
<p><a name="index-PARITY-936"></a><a name="index-Parity-937"></a><a name="index-Reduction_002c-XOR-938"></a><a name="index-XOR-reduction-939"></a>
<dl>
<dt><em>Description</em>:<dd>Calculates the parity, i.e. the reduction using <code>.XOR.</code>,
of <var>MASK</var> along dimension <var>DIM</var>.
<br><dt><em>Standard</em>:<dd>Fortran 2008 and later
<br><dt><em>Class</em>:<dd>Transformational function
<br><dt><em>Syntax</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="80%"><code>RESULT = PARITY(MASK[, DIM])</code>
<br></td></tr></table>
<br><dt><em>Arguments</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="15%"><var>LOGICAL</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>DIM</var> </td><td valign="top" width="70%">(Optional) shall be a scalar of type
<code>INTEGER</code> with a value in the range from 1 to n, where n
equals the rank of <var>MASK</var>.
<br></td></tr></table>
<br><dt><em>Return value</em>:<dd>The result is of the same type as <var>MASK</var>.
<p>If <var>DIM</var> is absent, a scalar with the parity of all elements in
<var>MASK</var> is returned, i.e. true if an odd number of elements is
<code>.true.</code> and false otherwise. If <var>DIM</var> is present, an array
of rank n-1, where n equals the rank of <var>ARRAY</var>,
and a shape similar to that of <var>MASK</var> with dimension <var>DIM</var>
dropped is returned.
<br><dt><em>Example</em>:<dd>
<pre class="smallexample"> PROGRAM test_sum
LOGICAL :: x(2) = [ .true., .false. ]
print *, PARITY(x) ! prints "T" (true).
END PROGRAM
</pre>
</dl>
</body></html>