man3/acosh.3

   1 '\" t
   2 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
   3 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
   4 .\"     <mtk.manpages@gmail.com>
   5 .\"
   6 .\" SPDX-License-Identifier: Linux-man-pages-copyleft
   7 .\"
   8 .\" References consulted:
   9 .\"     Linux libc source code
  10 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
  11 .\"     386BSD man pages
  12 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
  13 .\" Modified 2002-07-25 by Walter Harms
  14 .\"     (walter.harms@informatik.uni-oldenburg.de)
  15 .\"
  16 .TH acosh 3 (date) "Linux man-pages (unreleased)"
  17 .SH NAME
  18 acosh, acoshf, acoshl \- inverse hyperbolic cosine function
  19 .SH LIBRARY
  20 Math library
  21 .RI ( libm ", " \-lm )
  22 .SH SYNOPSIS
  23 .nf
  24 .B #include <math.h>
  25 .P
  26 .BI "double acosh(double " x );
  27 .BI "float acoshf(float " x );
  28 .BI "long double acoshl(long double " x );
  29 .P
  30 .fi
  31 .RS -4
  32 Feature Test Macro Requirements for glibc (see
  33 .BR feature_test_macros (7)):
  34 .RE
  35 .P
  36 .BR acosh ():
  37 .nf
  38     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  39         || _XOPEN_SOURCE >= 500
  40 .\"    || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED
  41         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  42         || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  43 .fi
  44 .P
  45 .BR acoshf (),
  46 .BR acoshl ():
  47 .nf
  48     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
  49         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
  50         || /* glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
  51 .fi
  52 .SH DESCRIPTION
  53 These functions calculate the inverse hyperbolic cosine of
  54 .IR x ;
  55 that is the value whose hyperbolic cosine is
  56 .IR x .
  57 .SH RETURN VALUE
  58 On success, these functions return the inverse hyperbolic cosine of
  59 .IR x .
  60 .P
  61 If
  62 .I x
  63 is a NaN, a NaN is returned.
  64 .P
  65 If
  66 .I x
  67 is +1, +0 is returned.
  68 .P
  69 If
  70 .I x
  71 is positive infinity, positive infinity is returned.
  72 .P
  73 If
  74 .I x
  75 is less than 1,
  76 a domain error occurs,
  77 and the functions return a NaN.
  78 .SH ERRORS
  79 See
  80 .BR math_error (7)
  81 for information on how to determine whether an error has occurred
  82 when calling these functions.
  83 .P
  84 The following errors can occur:
  85 .TP
  86 Domain error: \fIx\fP is less than 1
  87 .I errno
  88 is set to
  89 .BR EDOM .
  90 An invalid floating-point exception
  91 .RB ( FE_INVALID )
  92 is raised.
  93 .SH ATTRIBUTES
  94 For an explanation of the terms used in this section, see
  95 .BR attributes (7).
  96 .TS
  97 allbox;
  98 lbx lb lb
  99 l l l.
 100 Interface       Attribute       Value
 101 T{
 102 .na
 103 .nh
 104 .BR acosh (),
 105 .BR acoshf (),
 106 .BR acoshl ()
 107 T}      Thread safety   MT-Safe
 108 .TE
 109 .SH STANDARDS
 110 C11, POSIX.1-2008.
 111 .SH HISTORY
 112 C99, POSIX.1-2001.
 113 .P
 114 The variant returning
 115 .I double
 116 also conforms to
 117 SVr4, 4.3BSD.
 118 .SH SEE ALSO
 119 .BR asinh (3),
 120 .BR atanh (3),
 121 .BR cacosh (3),
 122 .BR cosh (3),
 123 .BR sinh (3),
 124 .BR tanh (3)