sphinx: add missing trailing newline

[thirdparty/gcc.git] / gcc / fortran / doc / gfortran / intrinsic-procedures / iparity.rst

..
  Copyright 1988-2022 Free Software Foundation, Inc.
  This is part of the GCC manual.
  For copying conditions, see the copyright.rst file.

.. index:: IPARITY, array, parity, array, XOR, bits, XOR of array elements

.. _iparity:

IPARITY --- Bitwise XOR of array elements
*****************************************

.. function:: IPARITY(ARRAY, DIM, MASK)

  Reduces with bitwise XOR (exclusive or) the elements of :samp:`{ARRAY}` along
  dimension :samp:`{DIM}` if the corresponding element in :samp:`{MASK}` is ``TRUE``.

  :param ARRAY:
    Shall be an array of type ``INTEGER``

  :param DIM:
    (Optional) shall be a scalar of type
    ``INTEGER`` with a value in the range from 1 to n, where n
    equals the rank of :samp:`{ARRAY}`.

  :param MASK:
    (Optional) shall be of type ``LOGICAL``
    and either be a scalar or an array of the same shape as :samp:`{ARRAY}`.

  :return:
    The result is of the same type as :samp:`{ARRAY}`.

  Standard:
    Fortran 2008 and later

  Class:
    Transformational function

  Syntax:
    .. code-block:: fortran

      RESULT = IPARITY(ARRAY[, MASK])
      RESULT = IPARITY(ARRAY, DIM[, MASK])

  Example:
    .. code-block:: fortran

      PROGRAM test_iparity
        INTEGER(1) :: a(2)

        a(1) = int(b'00100100', 1)
        a(2) = int(b'01101010', 1)

        ! prints 01001110
        PRINT '(b8.8)', IPARITY(a)
      END PROGRAM

  See also:
    :ref:`IANY`,
    :ref:`IALL`,
    :ref:`IEOR`,
    :ref:`PARITY`