Merge branch 'vendor/TCSH'
[dragonfly.git] / lib / libm / man / tanh.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: @(#)tanh.3        5.1 (Berkeley) 5/2/91
29 .\" $FreeBSD$
30 .\"
31 .Dd September 18, 2011
32 .Dt TANH 3
33 .Os
34 .Sh NAME
35 .Nm tanh ,
36 .Nm tanhf
37 .Nd hyperbolic tangent functions
38 .Sh LIBRARY
39 .Lb libm
40 .Sh SYNOPSIS
41 .In math.h
42 .Ft double
43 .Fn tanh "double x"
44 .Ft float
45 .Fn tanhf "float x"
46 .Sh DESCRIPTION
47 The
48 .Fn tanh
49 and the
50 .Fn tanhf
51 functions compute the hyperbolic tangent of
52 .Fa x .
53 For a discussion of error due to roundoff, see
54 .Xr math 3 .
55 .Sh RETURN VALUES
56 The
57 .Fn tanh
58 and the
59 .Fn tanhf
60 functions return the hyperbolic tangent value.
61 .Sh SEE ALSO
62 .Xr acos 3 ,
63 .Xr asin 3 ,
64 .Xr atan 3 ,
65 .Xr atan2 3 ,
66 .Xr cos 3 ,
67 .Xr cosh 3 ,
68 .Xr ctanh 3 ,
69 .Xr math 3 ,
70 .Xr sin 3 ,
71 .Xr sinh 3 ,
72 .Xr tan 3
73 .Sh STANDARDS
74 The
75 .Fn tanh
76 function conforms to
77 .St -isoC .