libm: Sync with FreeBSD (gains 6 long double functions)
[dragonfly.git] / lib / libm / man / tanh.3
CommitLineData
b34b60bc
JS
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
6ff43c94 29.\" $FreeBSD: head/lib/msun/man/tanh.3 226458 2011-10-17 05:41:03Z das $
b34b60bc 30.\"
2fedfd5c 31.Dd August 17, 2013
b34b60bc
JS
32.Dt TANH 3
33.Os
34.Sh NAME
35.Nm tanh ,
2fedfd5c
JM
36.Nm tanhf ,
37.Nm tanhl
8cecb502 38.Nd hyperbolic tangent functions
b34b60bc
JS
39.Sh LIBRARY
40.Lb libm
41.Sh SYNOPSIS
42.In math.h
43.Ft double
44.Fn tanh "double x"
45.Ft float
46.Fn tanhf "float x"
2fedfd5c
JM
47.Ft long double
48.Fn tanhl "long double x"
b34b60bc
JS
49.Sh DESCRIPTION
50The
2fedfd5c
JM
51.Fn tanh ,
52.Fn tanhf ,
53and
54.Fn tanhl
b34b60bc
JS
55functions compute the hyperbolic tangent of
56.Fa x .
57For a discussion of error due to roundoff, see
58.Xr math 3 .
59.Sh RETURN VALUES
8cecb502 60The
2fedfd5c
JM
61.Fn tanh ,
62.Fn tanhf ,
8cecb502 63and the
2fedfd5c 64.Fn tanhl
8cecb502 65functions return the hyperbolic tangent value.
b34b60bc
JS
66.Sh SEE ALSO
67.Xr acos 3 ,
68.Xr asin 3 ,
69.Xr atan 3 ,
70.Xr atan2 3 ,
71.Xr cos 3 ,
72.Xr cosh 3 ,
8cecb502 73.Xr ctanh 3 ,
b34b60bc
JS
74.Xr math 3 ,
75.Xr sin 3 ,
76.Xr sinh 3 ,
77.Xr tan 3
78.Sh STANDARDS
8cecb502
JM
79The
80.Fn tanh
81function conforms to
82.St -isoC .