mount_setattr.2: Further tweaks after feedback from Christian Brauner
[man-pages.git] / man3 / tanh.3
blobf011f2d9055088bcdbd6850f4b7c29f6dd9fb17e
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\" and Copyright 2008, Linux Foundation, written by Michael Kerrisk
3 .\"     <mtk.manpages@gmail.com>
4 .\"
5 .\" %%%LICENSE_START(VERBATIM)
6 .\" Permission is granted to make and distribute verbatim copies of this
7 .\" manual provided the copyright notice and this permission notice are
8 .\" preserved on all copies.
9 .\"
10 .\" Permission is granted to copy and distribute modified versions of this
11 .\" manual under the conditions for verbatim copying, provided that the
12 .\" entire resulting derived work is distributed under the terms of a
13 .\" permission notice identical to this one.
14 .\"
15 .\" Since the Linux kernel and libraries are constantly changing, this
16 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
17 .\" responsibility for errors or omissions, or for damages resulting from
18 .\" the use of the information contained herein.  The author(s) may not
19 .\" have taken the same level of care in the production of this manual,
20 .\" which is licensed free of charge, as they might when working
21 .\" professionally.
22 .\"
23 .\" Formatted or processed versions of this manual, if unaccompanied by
24 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" %%%LICENSE_END
26 .\"
27 .\" References consulted:
28 .\"     Linux libc source code
29 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
30 .\"     386BSD man pages
31 .\" Modified 1993-07-24 by Rik Faith (faith@cs.unc.edu)
32 .\" Modified 2002-07-27 by Walter Harms
33 .\"     (walter.harms@informatik.uni-oldenburg.de)
34 .\"
35 .TH TANH 3 2021-03-22 ""  "Linux Programmer's Manual"
36 .SH NAME
37 tanh, tanhf, tanhl \- hyperbolic tangent function
38 .SH SYNOPSIS
39 .nf
40 .B #include <math.h>
41 .PP
42 .BI "double tanh(double " x );
43 .BI "float tanhf(float " x );
44 .BI "long double tanhl(long double " x );
45 .fi
46 .PP
47 Link with \fI\-lm\fP.
48 .PP
49 .RS -4
50 Feature Test Macro Requirements for glibc (see
51 .BR feature_test_macros (7)):
52 .RE
53 .PP
54 .BR tanhf (),
55 .BR tanhl ():
56 .nf
57     _ISOC99_SOURCE || _POSIX_C_SOURCE >= 200112L
58         || /* Since glibc 2.19: */ _DEFAULT_SOURCE
59         || /* Glibc <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE
60 .fi
61 .SH DESCRIPTION
62 These functions return the hyperbolic tangent of
63 .IR x ,
64 which
65 is defined mathematically as:
66 .PP
67 .nf
68     tanh(x) = sinh(x) / cosh(x)
69 .fi
70 .SH RETURN VALUE
71 On success, these functions return the hyperbolic tangent of
72 .IR x .
73 .PP
75 .I x
76 is a NaN, a NaN is returned.
77 .PP
79 .I x
80 is +0 (\-0), +0 (\-0) is returned.
81 .PP
83 .I x
84 is positive infinity (negative infinity),
85 +1 (\-1) is returned.
86 .\"
87 .\" POSIX.1-2001 documents an optional range error (underflow)
88 .\" for subnormal x;
89 .\" glibc 2.8 does not do this.
90 .SH ERRORS
91 No errors occur.
92 .SH ATTRIBUTES
93 For an explanation of the terms used in this section, see
94 .BR attributes (7).
95 .ad l
96 .nh
97 .TS
98 allbox;
99 lbx lb lb
100 l l l.
101 Interface       Attribute       Value
103 .BR tanh (),
104 .BR tanhf (),
105 .BR tanhl ()
106 T}      Thread safety   MT-Safe
110 .sp 1
111 .SH CONFORMING TO
112 C99, POSIX.1-2001, POSIX.1-2008.
114 The variant returning
115 .I double
116 also conforms to
117 SVr4, 4.3BSD, C89.
118 .SH SEE ALSO
119 .BR acosh (3),
120 .BR asinh (3),
121 .BR atanh (3),
122 .BR cosh (3),
123 .BR ctanh (3),
124 .BR sinh (3)