gcc/fortran/doc/gfortran/intrinsic-procedures/acosh.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 .. _acosh:
   7
   8 .. index:: ACOSH
   9
  10 .. index:: DACOSH
  11
  12 .. index:: area hyperbolic cosine
  13
  14 .. index:: inverse hyperbolic cosine
  15
  16 .. index:: hyperbolic function, cosine, inverse
  17
  18 .. index:: cosine, hyperbolic, inverse
  19
  20 ACOSH --- Inverse hyperbolic cosine function
  21 ********************************************
  22
  23 .. function:: ACOSH(X)
  24
  25   ``ACOSH(X)`` computes the inverse hyperbolic cosine of :samp:`{X}`.
  26
  27   :param X:
  28     The type shall be ``REAL`` or ``COMPLEX``.
  29
  30   :return:
  31     The return value has the same type and kind as :samp:`{X}`. If :samp:`{X}` is
  32     complex, the imaginary part of the result is in radians and lies between
  33     0 \leq \Im \acosh(x) \leq \pi.
  34
  35   Standard:
  36     Fortran 2008 and later
  37
  38   Class:
  39     Elemental function
  40
  41   Syntax:
  42     .. code-block:: fortran
  43
  44       RESULT = ACOSH(X)
  45
  46   Example:
  47     .. code-block:: fortran
  48
  49       PROGRAM test_acosh
  50         REAL(8), DIMENSION(3) :: x = (/ 1.0, 2.0, 3.0 /)
  51         WRITE (*,*) ACOSH(x)
  52       END PROGRAM
  53
  54   Specific names:
  55     .. list-table::
  56        :header-rows: 1
  57
  58        * - Name
  59          - Argument
  60          - Return type
  61          - Standard
  62
  63        * - ``DACOSH(X)``
  64          - ``REAL(8) X``
  65          - ``REAL(8)``
  66          - GNU extension
  67
  68   See also:
  69     Inverse function:
  70     :ref:`COSH`