Debian Codegraph @

upstream/debian-unstable/man3/acosh.3

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