original/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  2010-09-20 "" "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
  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
  46 .fi
  47 Link with \fI\-lm\fP.
  48 .sp
  49 .in -4n
  50 Feature Test Macro Requirements for glibc (see
  51 .BR feature_test_macros (7)):
  52 .in
  53 .sp
  54 .ad l
  55 .BR atan2f (),
  56 .BR atan2l ():
  57 .RS
  58 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 600 || _ISOC99_SOURCE ||
  59 _POSIX_C_SOURCE\ >=\ 200112L;
  60 .br
  61 or
  62 .I cc\ -std=c99
  63 .RE
  64 .ad b
  65 .SH DESCRIPTION
  66 The
  67 .BR atan2 ()
  68 function calculates the principal value of the arc tangent of
  69 .IR y/x ,
  70 using the signs of the two arguments to determine
  71 the quadrant of the result.
  72 .SH RETURN VALUE
  73 On success, these functions return the principal value of the arc tangent of
  74 .IR y/x
  75 in radians; the return value is in the range [\-pi,\ pi].
  76
  77 If
  78 .I y
  79 is +0 (\-0) and
  80 .I x
  81 is less than 0, +pi (\-pi) is returned.
  82
  83 If
  84 .I y
  85 is +0 (\-0) and
  86 .I x
  87 is greater than 0, +0 (\-0) is returned.
  88
  89 If
  90 .I y
  91 is less than 0 and
  92 .I x
  93 is +0 or \-0, \-pi/2 is returned.
  94
  95 If
  96 .I y
  97 is greater than 0 and
  98 .I x
  99 is +0 or \-0, pi/2 is returned.
 100
 101 .\" POSIX.1 says:
 102 .\" If
 103 .\" .I x
 104 .\" is 0, a pole error shall not occur.
 105 .\"
 106 If either
 107 .I x
 108 or
 109 .I y
 110 is NaN, a NaN is returned.
 111
 112 .\" POSIX.1 says:
 113 .\" If the result underflows, a range error may occur and
 114 .\" .I y/x
 115 .\" should be returned.
 116 .\"
 117 If
 118 .I y
 119 is +0 (\-0) and
 120 .I x
 121 is \-0, +pi (\-pi) is returned.
 122
 123 If
 124 .I y
 125 is +0 (\-0) and
 126 .I x
 127 is +0, +0 (\-0) is returned.
 128
 129 If
 130 .I y
 131 is a finite value greater (less) than 0, and
 132 .I x
 133 is negative infinity, +pi (\-pi) is returned.
 134
 135 If
 136 .I y
 137 is a finite value greater (less) than 0, and
 138 .I x
 139 is positive infinity, +0 (\-0) is returned.
 140
 141 If
 142 .I y
 143 is positive infinity (negative infinity), and
 144 .I x
 145 is finite,
 146 pi/2 (\-pi/2) is returned.
 147
 148 If
 149 .I y
 150 is positive infinity (negative infinity) and
 151 .I x
 152 is negative infinity, +3*pi/4 (\-3*pi/4) is returned.
 153
 154 If
 155 .I y
 156 is positive infinity (negative infinity) and
 157 .I x
 158 is positive infinity, +pi/4 (\-pi/4) is returned.
 159 .\"
 160 .\" POSIX.1 says:
 161 .\" If both arguments are 0, a domain error shall not occur.
 162 .SH ERRORS
 163 No errors occur.
 164 .\" POSIX.1 documents an optional underflow error
 165 .\" glibc 2.8 does not do this.
 166 .SH CONFORMING TO
 167 C99, POSIX.1-2001.
 168 The variant returning
 169 .I double
 170 also conforms to
 171 SVr4, 4.3BSD, C89.
 172 .SH SEE ALSO
 173 .BR acos (3),
 174 .BR asin (3),
 175 .BR atan (3),
 176 .BR carg (3),
 177 .BR cos (3),
 178 .BR sin (3),
 179 .BR tan (3)
 180 .SH COLOPHON
 181 This page is part of release 3.65 of the Linux
 182 .I man-pages
 183 project.
 184 A description of the project,
 185 and information about reporting bugs,
 186 can be found at
 187 \%http://www.kernel.org/doc/man\-pages/.