Debian Codegraph @

upstream/debian-trixie/man3/asinh.3

raw
1 '\" t
2 .\" Copyright 1993 David Metcalfe ([email protected])
3 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
4 .\" <[email protected]>
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 ([email protected])
13 .\" Modified 2002-07-27 by Walter Harms
14 .\" ([email protected])
15 .\"
16 .TH asinh 3 2024-05-02 "Linux man-pages 6.9.1"
17 .SH NAME
18 asinh, asinhf, asinhl \- inverse hyperbolic sine 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 asinh(double " x );
27 .BI "float asinhf(float " x );
28 .BI "long double asinhl(long double " x );
29 .fi
30 .P
31 .RS -4
32 Feature Test Macro Requirements for glibc (see
33 .BR feature_test_macros (7)):
34 .RE
35 .P
36 .BR asinh ():
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 asinhf (),
46 .BR asinhl ():
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 sine of
54 .IR x ;
55 that is the value whose hyperbolic sine is
56 .IR x .
57 .SH RETURN VALUE
58 On success, these functions return the inverse hyperbolic sine 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 +0 (\-0), +0 (\-0) is returned.
68 .P
69 If
70 .I x
71 is positive infinity (negative infinity),
72 positive infinity (negative infinity) is returned.
73 .\"
74 .\" POSIX.1-2001 documents an optional range error for subnormal x;
75 .\" glibc 2.8 does not do this.
76 .SH ERRORS
77 No errors occur.
78 .SH ATTRIBUTES
79 For an explanation of the terms used in this section, see
80 .BR attributes (7).
81 .TS
82 allbox;
83 lbx lb lb
84 l l l.
85 Interface Attribute Value
86 T{
87 .na
88 .nh
89 .BR asinh (),
90 .BR asinhf (),
91 .BR asinhl ()
92 T} Thread safety MT-Safe
93 .TE
94 .SH STANDARDS
95 C11, POSIX.1-2008.
96 .SH HISTORY
97 C99, POSIX.1-2001.
98 .P
99 The variant returning
100 .I double
101 also conforms to
102 SVr4, 4.3BSD.
103 .SH SEE ALSO
104 .BR acosh (3),
105 .BR atanh (3),
106 .BR casinh (3),
107 .BR cosh (3),
108 .BR sinh (3),
109 .BR tanh (3)