xref: /netbsd-src/lib/libm/man/tanh.3 (revision 7690962a143b99b7634b1782f4680d8cffeb0a2f)
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.\"	$NetBSD: tanh.3,v 1.16 2024/01/26 19:27:30 nros Exp $
30.\"
31.Dd September 18, 2011
32.Dt TANH 3
33.Os
34.Sh NAME
35.Nm tanh ,
36.Nm tanhf ,
37.Nm tanhl
38.Nd hyperbolic tangent function
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"
47.Ft long double
48.Fn tanhl "long double x"
49.Sh DESCRIPTION
50The
51.Fn tanh
52.Fn tanhf
53and
54.Fn tanhl
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
60Upon successful completion,
61these functions return the hyperbolic tangent value.
62The following may also occur:
63.Bl -enum -offset indent
64.It
65If
66.Fa x
67is \*(Pm 0,
68.Fa x
69is returned.
70.It
71If
72.Fa x
73is \*(Na, a \*(Na is returned.
74.It
75If
76.Fa x
77is positive infinity, a value 1 is returned;
78if
79.Fa x
80is negative infinity, -1 is returned.
81.It
82If
83.Fa x
84is subnormal, a range error can occur and
85.Fa x
86is returned.
87.El
88.Sh SEE ALSO
89.Xr acos 3 ,
90.Xr asin 3 ,
91.Xr atan 3 ,
92.Xr atan2 3 ,
93.Xr cos 3 ,
94.Xr cosh 3 ,
95.Xr math 3 ,
96.Xr sin 3 ,
97.Xr sinh 3 ,
98.Xr tan 3
99.Sh STANDARDS
100The described functions conform to
101.St -isoC-99 .
102