man3/atan2.3

   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 ATAN2 3  2021-03-22 "" "Linux Programmer's Manual"
  36 .SH NAME
  37 atan2, atan2f, atan2l \- arc tangent function of two variables
  38 .SH SYNOPSIS
  39 .nf
  40 .B #include <math.h>
  41 .PP
  42 .BI "double atan2(double " y ", double " x );
  43 .BI "float atan2f(float " y ", float " x );
  44 .BI "long double atan2l(long double " y ", 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 atan2f (),
  55 .BR atan2l ():
  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 calculate the principal value of the arc tangent of
  63 .IR y/x ,
  64 using the signs of the two arguments to determine
  65 the quadrant of the result.
  66 .SH RETURN VALUE
  67 On success, these functions return the principal value of the arc tangent of
  68 .IR y/x
  69 in radians; the return value is in the range [\-pi,\ pi].
  70 .PP
  71 If
  72 .I y
  73 is +0 (\-0) and
  74 .I x
  75 is less than 0, +pi (\-pi) is returned.
  76 .PP
  77 If
  78 .I y
  79 is +0 (\-0) and
  80 .I x
  81 is greater than 0, +0 (\-0) is returned.
  82 .PP
  83 If
  84 .I y
  85 is less than 0 and
  86 .I x
  87 is +0 or \-0, \-pi/2 is returned.
  88 .PP
  89 If
  90 .I y
  91 is greater than 0 and
  92 .I x
  93 is +0 or \-0, pi/2 is returned.
  94 .PP
  95 .\" POSIX.1 says:
  96 .\" If
  97 .\" .I x
  98 .\" is 0, a pole error shall not occur.
  99 .\"
 100 If either
 101 .I x
 102 or
 103 .I y
 104 is NaN, a NaN is returned.
 105 .PP
 106 .\" POSIX.1 says:
 107 .\" If the result underflows, a range error may occur and
 108 .\" .I y/x
 109 .\" should be returned.
 110 .\"
 111 If
 112 .I y
 113 is +0 (\-0) and
 114 .I x
 115 is \-0, +pi (\-pi) is returned.
 116 .PP
 117 If
 118 .I y
 119 is +0 (\-0) and
 120 .I x
 121 is +0, +0 (\-0) is returned.
 122 .PP
 123 If
 124 .I y
 125 is a finite value greater (less) than 0, and
 126 .I x
 127 is negative infinity, +pi (\-pi) is returned.
 128 .PP
 129 If
 130 .I y
 131 is a finite value greater (less) than 0, and
 132 .I x
 133 is positive infinity, +0 (\-0) is returned.
 134 .PP
 135 If
 136 .I y
 137 is positive infinity (negative infinity), and
 138 .I x
 139 is finite,
 140 pi/2 (\-pi/2) is returned.
 141 .PP
 142 If
 143 .I y
 144 is positive infinity (negative infinity) and
 145 .I x
 146 is negative infinity, +3*pi/4 (\-3*pi/4) is returned.
 147 .PP
 148 If
 149 .I y
 150 is positive infinity (negative infinity) and
 151 .I x
 152 is positive infinity, +pi/4 (\-pi/4) is returned.
 153 .\"
 154 .\" POSIX.1 says:
 155 .\" If both arguments are 0, a domain error shall not occur.
 156 .SH ERRORS
 157 No errors occur.
 158 .\" POSIX.1 documents an optional underflow error
 159 .\" glibc 2.8 does not do this.
 160 .SH ATTRIBUTES
 161 For an explanation of the terms used in this section, see
 162 .BR attributes (7).
 163 .ad l
 164 .nh
 165 .TS
 166 allbox;
 167 lbx lb lb
 168 l l l.
 169 Interface       Attribute       Value
 170 T{
 171 .BR atan2 (),
 172 .BR atan2f (),
 173 .BR atan2l ()
 174 T}      Thread safety   MT-Safe
 175 .TE
 176 .hy
 177 .ad
 178 .sp 1
 179 .SH CONFORMING TO
 180 C99, POSIX.1-2001, POSIX.1-2008.
 181 .PP
 182 The variant returning
 183 .I double
 184 also conforms to
 185 SVr4, 4.3BSD, C89.
 186 .SH SEE ALSO
 187 .BR acos (3),
 188 .BR asin (3),
 189 .BR atan (3),
 190 .BR carg (3),
 191 .BR cos (3),
 192 .BR sin (3),
 193 .BR tan (3)