Changes: Ready for 5.13
[man-pages.git] / man3 / tan.3
blob7221f111e3d487588d68a92840fda7fe28cedd89
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 TAN 3 2021-03-22 ""  "Linux Programmer's Manual"
36 .SH NAME
37 tan, tanf, tanl \- tangent function
38 .SH SYNOPSIS
39 .nf
40 .B #include <math.h>
41 .PP
42 .BI "double tan(double " x );
43 .BI "float tanf(float " x );
44 .BI "long double tanl(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 tanf (),
55 .BR tanl ():
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 tangent of
63 .IR x ,
64 where
65 .I x
67 given in radians.
68 .SH RETURN VALUE
69 On success, these functions return the tangent of
70 .IR x .
71 .PP
73 .I x
74 is a NaN, a NaN is returned.
75 .PP
77 .I x
78 is positive infinity or negative infinity,
79 a domain error occurs,
80 and a NaN is returned.
81 .PP
82 If the correct result would overflow,
83 a range error occurs,
84 and the functions return
85 .BR HUGE_VAL ,
86 .BR HUGE_VALF ,
88 .BR HUGE_VALL ,
89 respectively, with the mathematically correct sign.
90 .\" I think overflow can't occur, because the closest floating-point
91 .\" representation of pi/2 is still not close enough to pi/2 to
92 .\" produce a large enough value to overflow.
93 .\" Testing certainly seems to bear this out.  -- mtk, Jul 08
94 .\"
95 .\" POSIX.1 allows an optional underflow error;
96 .\" glibc 2.8 doesn't do this
97 .\" POSIX.1 an optional range error for subnormal x;
98 .\" glibc 2.8 doesn't do this
99 .SH ERRORS
101 .BR math_error (7)
102 for information on how to determine whether an error has occurred
103 when calling these functions.
105 The following errors can occur:
107 Domain error: \fIx\fP is an infinity
108 .I errno
109 is set to
110 .B EDOM
111 (but see BUGS).
112 An invalid floating-point exception
113 .RB ( FE_INVALID )
114 is raised.
116 Range error: result overflow
117 .\" Unable to test this case, since the best approximation of
118 .\" pi/2 in double precision only yields a tan() value of 1.633e16.
119 .\" .I errno
120 .\" is set to
121 .\" .BR ERANGE .
122 An overflow floating-point exception
123 .RB ( FE_OVERFLOW )
124 is raised.
125 .SH ATTRIBUTES
126 For an explanation of the terms used in this section, see
127 .BR attributes (7).
128 .ad l
131 allbox;
132 lbx lb lb
133 l l l.
134 Interface       Attribute       Value
136 .BR tan (),
137 .BR tanf (),
138 .BR tanl ()
139 T}      Thread safety   MT-Safe
143 .sp 1
144 .SH CONFORMING TO
145 C99, POSIX.1-2001, POSIX.1-2008.
147 The variant returning
148 .I double
149 also conforms to
150 SVr4, 4.3BSD, C89.
151 .SH BUGS
152 Before version 2.10, the glibc implementation did not set
153 .\" http://sourceware.org/bugzilla/show_bug.cgi?id=6782
154 .I errno
156 .B EDOM
157 when a domain error occurred.
158 .SH SEE ALSO
159 .BR acos (3),
160 .BR asin (3),
161 .BR atan (3),
162 .BR atan2 (3),
163 .BR cos (3),
164 .BR ctan (3),
165 .BR sin (3)