]> git.ipfire.org Git - thirdparty/man-pages.git/blob - man3/sinh.3
acos.3, acosh.3, asin.3, asinh.3, atan.3, atan2.3, atanh.3, ceil.3, cos.3, cosh.3...
[thirdparty/man-pages.git] / man3 / sinh.3
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 2015-03-02 "" "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 .sp
43 .BI "double sinh(double " x );
44 .br
45 .BI "float sinhf(float " x );
46 .br
47 .BI "long double sinhl(long double " x );
48 .fi
49 .sp
50 Link with \fI\-lm\fP.
51 .sp
52 .in -4n
53 Feature Test Macro Requirements for glibc (see
54 .BR feature_test_macros (7)):
55 .in
56 .sp
57 .ad l
58 .BR sinhf (),
59 .BR sinhl ():
60 .RS 4
61 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
62 _POSIX_C_SOURCE\ >=\ 200112L;
63 .br
64 or
65 .I cc\ -std=c99
66 .RE
67 .ad
68 .SH DESCRIPTION
69 The
70 .BR sinh ()
71 function returns the hyperbolic sine of
72 .IR x ,
73 which
74 is defined mathematically as:
75 .nf
76
77 sinh(x) = (exp(x) \- exp(\-x)) / 2
78 .fi
79 .SH RETURN VALUE
80 On success, these functions return the hyperbolic sine of
81 .IR x .
82
83 If
84 .I x
85 is a NaN, a NaN is returned.
86
87 If
88 .I x
89 is +0 (\-0), +0 (\-0) is returned.
90
91 If
92 .I x
93 is positive infinity (negative infinity),
94 positive infinity (negative infinity) is returned.
95
96 If the result overflows,
97 a range error occurs,
98 and the functions return
99 .BR HUGE_VAL ,
100 .BR HUGE_VALF ,
101 or
102 .BR HUGE_VALL ,
103 respectively, with the same sign as
104 .IR x .
105 .\"
106 .\" POSIX.1-2001 documents an optional range error (underflow)
107 .\" for subnormal x;
108 .\" glibc 2.8 does not do this.
109 .SH ERRORS
110 See
111 .BR math_error (7)
112 for information on how to determine whether an error has occurred
113 when calling these functions.
114 .PP
115 The following errors can occur:
116 .TP
117 Range error: result overflow
118 .I errno
119 is set to
120 .BR ERANGE .
121 An overflow floating-point exception
122 .RB ( FE_OVERFLOW )
123 is raised.
124 .SH ATTRIBUTES
125 For an explanation of the terms used in this section, see
126 .BR attributes (7).
127 .TS
128 allbox;
129 lbw24 lb lb
130 l l l.
131 Interface Attribute Value
132 T{
133 .BR sinh (),
134 .BR sinhf (),
135 .BR sinhl ()
136 T} Thread safety MT-Safe
137 .TE
138 .SH CONFORMING TO
139 C99, POSIX.1-2001.
140
141 The variant returning
142 .I double
143 also conforms to
144 SVr4, 4.3BSD, C89.
145 .SH SEE ALSO
146 .BR acosh (3),
147 .BR asinh (3),
148 .BR atanh (3),
149 .BR cosh (3),
150 .BR csinh (3),
151 .BR tanh (3)