gcc/fortran/doc/gfortran/intrinsic-procedures/ucobound.rst

   1 ..
   2   Copyright 1988-2022 Free Software Foundation, Inc.
   3   This is part of the GCC manual.
   4   For copying conditions, see the copyright.rst file.
   5
   6 .. index:: UCOBOUND, coarray, upper bound
   7
   8 .. _ucobound:
   9
  10 UCOBOUND --- Upper codimension bounds of an array
  11 *************************************************
  12
  13 .. function:: UCOBOUND(COARRAY , DIM , KIND)
  14
  15   Returns the upper cobounds of a coarray, or a single upper cobound
  16   along the :samp:`{DIM}` codimension.
  17
  18   :param ARRAY:
  19     Shall be an coarray, of any type.
  20
  21   :param DIM:
  22     (Optional) Shall be a scalar ``INTEGER``.
  23
  24   :param KIND:
  25     (Optional) An ``INTEGER`` initialization
  26     expression indicating the kind parameter of the result.
  27
  28   :return:
  29     The return value is of type ``INTEGER`` and of kind :samp:`{KIND}`. If
  30     :samp:`{KIND}` is absent, the return value is of default integer kind.
  31     If :samp:`{DIM}` is absent, the result is an array of the lower cobounds of
  32     :samp:`{COARRAY}`.  If :samp:`{DIM}` is present, the result is a scalar
  33     corresponding to the lower cobound of the array along that codimension.
  34
  35   Standard:
  36     Fortran 2008 and later
  37
  38   Class:
  39     Inquiry function
  40
  41   Syntax:
  42     .. code-block:: fortran
  43
  44       RESULT = UCOBOUND(COARRAY [, DIM [, KIND]])
  45
  46   See also:
  47     :ref:`LCOBOUND`,
  48     :ref:`LBOUND`