Merge branch 'vendor/XZ'
[dragonfly.git] / lib / libm / man / sinh.3
1 .\" Copyright (c) 1991 The Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     from: @(#)sinh.3        6.6 (Berkeley) 4/19/91
29 .\" $FreeBSD$
30 .Dd December 21, 2011
31 .Dt SINH 3
32 .Os
33 .Sh NAME
34 .Nm sinh ,
35 .Nm sinhf
36 .Nd hyperbolic sine function
37 .Sh LIBRARY
38 .Lb libm
39 .Sh SYNOPSIS
40 .In math.h
41 .Ft double
42 .Fn sinh "double x"
43 .Ft float
44 .Fn sinhf "float x"
45 .Sh DESCRIPTION
46 The
47 .Fn sinh
48 and the
49 .Fn sinhf
50 functions compute the hyperbolic sine of
51 .Fa x .
52 .Sh RETURN VALUES
53 The
54 .Fn sinh
55 function returns the hyperbolic sine value unless
56 the magnitude of
57 .Fa x
58 is too large; in this event, the global variable
59 .Va errno
60 is set to
61 .Er ERANGE .
62 .Sh SEE ALSO
63 .Xr acos 3 ,
64 .Xr asin 3 ,
65 .Xr atan 3 ,
66 .Xr atan2 3 ,
67 .Xr cos 3 ,
68 .Xr cosh 3 ,
69 .Xr csinh 3 ,
70 .Xr math 3 ,
71 .Xr sin 3 ,
72 .Xr tan 3 ,
73 .Xr tanh 3
74 .Sh STANDARDS
75 The
76 .Fn sinh
77 function conforms to
78 .St -isoC .