xref: /freebsd/lib/msun/man/tanh.3 (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
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.Dd April 3, 2022
29.Dt TANH 3
30.Os
31.Sh NAME
32.Nm tanh ,
33.Nm tanhf ,
34.Nm tanhl
35.Nd hyperbolic tangent functions
36.Sh LIBRARY
37.Lb libm
38.Sh SYNOPSIS
39.In math.h
40.Ft double
41.Fn tanh "double x"
42.Ft float
43.Fn tanhf "float x"
44.Ft long double
45.Fn tanhl "long double x"
46.Sh DESCRIPTION
47The
48.Fn tanh ,
49.Fn tanhf ,
50and
51.Fn tanhl
52functions compute the hyperbolic tangent of
53.Fa x .
54For a discussion of error due to roundoff, see
55.Xr math 3 .
56.Sh RETURN VALUES
57The
58.Fn tanh ,
59.Fn tanhf ,
60and the
61.Fn tanhl
62functions return the hyperbolic tangent value.
63.Sh SEE ALSO
64.Xr acos 3 ,
65.Xr asin 3 ,
66.Xr atan 3 ,
67.Xr atan2 3 ,
68.Xr cos 3 ,
69.Xr cosh 3 ,
70.Xr ctanh 3 ,
71.Xr math 3 ,
72.Xr sin 3 ,
73.Xr sinh 3 ,
74.Xr tan 3
75.Sh STANDARDS
76The
77.Fn tanh
78function conforms to
79.St -isoC .
80.Sh HISTORY
81The
82.Fn tanh
83function first appeared in
84.At v7 .
85