Changes: Ready for 5.13
[man-pages.git] / man3 / sinh.3
blob2496a637b4c409b43ea6aa37a412b35151221380
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
3 .\"     <mtk.manpages@gmail.com>
4 .\"
5 .\" %%%LICENSE_START(VERBATIM)
6 .\" Permission is granted to make and distribute verbatim copies of this
7 .\" manual provided the copyright notice and this permission notice are
8 .\" preserved on all copies.
9 .\"
10 .\" Permission is granted to copy and distribute modified versions of this
11 .\" manual under the conditions for verbatim copying, provided that the
12 .\" entire resulting derived work is distributed under the terms of a
13 .\" permission notice identical to this one.
14 .\"
15 .\" Since the Linux kernel and libraries are constantly changing, this
16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
17 .\" responsibility for errors or omissions, or for damages resulting from
18 .\" the use of the information contained herein.  The author(s) may not
19 .\" have taken the same level of care in the production of this manual,
20 .\" which is licensed free of charge, as they might when working
21 .\" professionally.
22 .\"
23 .\" Formatted or processed versions of this manual, if unaccompanied by
24 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" %%%LICENSE_END
26 .\"
27 .\" References consulted:
28 .\"     Linux libc source code
29 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
30 .\"     386BSD man pages
31 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
32 .\" Modified 1996-06-08 by aeb
33 .\" Modified 2002-07-27 by Walter Harms
34 .\"     (walter.harms@informatik.uni-oldenburg.de)
35 .\"
36 .TH SINH 3  2021-03-22 "" "Linux Programmer's Manual"
37 .SH NAME
38 sinh, sinhf, sinhl \- hyperbolic sine function
39 .SH SYNOPSIS
40 .nf
41 .B #include <math.h>
42 .PP
43 .BI "double sinh(double " x );
44 .BI "float sinhf(float " x );
45 .BI "long double sinhl(long double " x );
46 .fi
47 .PP
48 Link with \fI\-lm\fP.
49 .PP
50 .RS -4
51 Feature Test Macro Requirements for glibc (see
52 .BR feature_test_macros (7)):
53 .RE
54 .PP
55 .BR sinhf (),
56 .BR sinhl ():
57 .nf
58     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
59         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
60         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
61 .fi
62 .SH DESCRIPTION
63 These functions return the hyperbolic sine of
64 .IR x ,
65 which
66 is defined mathematically as:
67 .PP
68 .nf
69     sinh(x) = (exp(x) \- exp(\-x)) / 2
70 .fi
71 .SH RETURN VALUE
72 On success, these functions return the hyperbolic sine of
73 .IR x .
74 .PP
76 .I x
77 is a NaN, a NaN is returned.
78 .PP
80 .I x
81 is +0 (\-0), +0 (\-0) is returned.
82 .PP
84 .I x
85 is positive infinity (negative infinity),
86 positive infinity (negative infinity) is returned.
87 .PP
88 If the result overflows,
89 a range error occurs,
90 and the functions return
91 .BR HUGE_VAL ,
92 .BR HUGE_VALF ,
94 .BR HUGE_VALL ,
95 respectively, with the same sign as
96 .IR x .
97 .\"
98 .\" POSIX.1-2001 documents an optional range error (underflow)
99 .\" for subnormal x;
100 .\" glibc 2.8 does not do this.
101 .SH ERRORS
103 .BR math_error (7)
104 for information on how to determine whether an error has occurred
105 when calling these functions.
107 The following errors can occur:
109 Range error: result overflow
110 .I errno
111 is set to
112 .BR ERANGE .
113 An overflow floating-point exception
114 .RB ( FE_OVERFLOW )
115 is raised.
116 .SH ATTRIBUTES
117 For an explanation of the terms used in this section, see
118 .BR attributes (7).
119 .ad l
122 allbox;
123 lbx lb lb
124 l l l.
125 Interface       Attribute       Value
127 .BR sinh (),
128 .BR sinhf (),
129 .BR sinhl ()
130 T}      Thread safety   MT-Safe
134 .sp 1
135 .SH CONFORMING TO
136 C99, POSIX.1-2001, POSIX.1-2008.
138 The variant returning
139 .I double
140 also conforms to
141 SVr4, 4.3BSD, C89.
142 .SH SEE ALSO
143 .BR acosh (3),
144 .BR asinh (3),
145 .BR atanh (3),
146 .BR cosh (3),
147 .BR csinh (3),
148 .BR tanh (3)