usr/src/man/man3m/atan2.3m

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  45 .\" Portions Copyright (c) 2006, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH ATAN2 3M "Jul 12, 2006" "SunOS 5.11" "Mathematical Library Functions"
  48 .SH NAME
  49 atan2, atan2f, atan2l \- arc tangent function
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 c99 [ \fIflag\fR... ] \fIfile\fR... \fB-lm\fR [ \fIlibrary\fR... ]
  54 #include <math.h>
  55
  56 \fBdouble\fR \fBatan2\fR(\fBdouble\fR \fIy\fR, \fBdouble\fR \fIx\fR);
  57 .fi
  58
  59 .LP
  60 .nf
  61 \fBfloat\fR \fBatan2f\fR(\fBfloat\fR \fIy\fR, \fBfloat\fR \fIx\fR);
  62 .fi
  63
  64 .LP
  65 .nf
  66 \fBlong double\fR \fBatan2l\fR(\fBlong double\fR \fIy\fR, \fBlong double\fR \fIx\fR);
  67 .fi
  68
  69 .SH DESCRIPTION
  70 .sp
  71 .LP
  72 These functions compute the principal value of the arc tangent of \fIy/x\fR,
  73 using the signs of both arguments to determine the quadrant of the return
  74 value.
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 Upon successful completion, these functions return the arc tangent of
  79 \fIy\fR/\fIx\fR in the range [ \(mi\c
  80 .if n pi\c
  81 .if t \(*p
  82 \c
  83 ,\c
  84 .if n pi\c
  85 .if t \(*p
  86 \c
  87  ] radians.
  88 .sp
  89 .LP
  90 If \fIy\fR is \(+-0 and \fIx\fR is < 0, \(+-\c
  91 .if n pi\c
  92 .if t \(*p
  93 \c
  94  is returned.
  95 .sp
  96 .LP
  97 If \fIy\fR is \(+-0 and \fIx\fR is > 0, \(+-0 is returned.
  98 .sp
  99 .LP
 100 If \fIy\fR is < 0 and \fIx\fR is \(+-0, \(mi\c
 101 .if n pi\c
 102 .if t \(*p
 103 \c
 104 /2 is returned.
 105 .sp
 106 .LP
 107 If \fIy\fR is > 0 and \fIx\fR is \(+-0, \c
 108 .if n pi\c
 109 .if t \(*p
 110 \c
 111 /2 is returned.
 112 .sp
 113 .LP
 114 If \fIx\fR is 0, a pole error does not occur.
 115 .sp
 116 .LP
 117 If either \fIx\fR or \fIy\fR is NaN, a NaN is returned.
 118 .sp
 119 .LP
 120 If \fIy\fR is \(+-0 and \fIx\fR is -0, \(+-\c
 121 .if n pi\c
 122 .if t \(*p
 123 \c
 124  is returned.
 125 .sp
 126 .LP
 127 If \fIy\fR is \(+-0 and \fIx\fR is +0, \(+-0 is returned.
 128 .sp
 129 .LP
 130 For finite values of \(+-\fIy\fR > 0, if x is \(miInf,  \(+-\c
 131 .if n pi\c
 132 .if t \(*p
 133 \c
 134  is returned.
 135 .sp
 136 .LP
 137 For finite values of \(+-\fIy\fR > 0, if x is +Inf,  \(+-0 is returned.
 138 .sp
 139 .LP
 140 For finite values of \fIx\fR, if \fIy\fR is \(+-Inf, \(+-\c
 141 .if n pi\c
 142 .if t \(*p
 143 \c
 144 /2 is returned.
 145 .sp
 146 .LP
 147 If \fIy\fR is \(+-Inf and \fIx\fR is \(miInf, \(+-3\c
 148 .if n pi\c
 149 .if t \(*p
 150 \c
 151 /4 is returned.
 152 .sp
 153 .LP
 154 If \fIy\fR is \(+-Inf and \fIx\fR is +Inf, \(+-\c
 155 .if n pi\c
 156 .if t \(*p
 157 \c
 158 /4 is returned.
 159 .sp
 160 .LP
 161 If both arguments are 0, a domain error does not occur.
 162 .SH ERRORS
 163 .sp
 164 .LP
 165 No errors are defined.
 166 .SH ATTRIBUTES
 167 .sp
 168 .LP
 169 See \fBattributes\fR(5) for descriptions of the following attributes:
 170 .sp
 171
 172 .sp
 173 .TS
 174 tab(    ) box;
 175 cw(2.75i) |cw(2.75i)
 176 lw(2.75i) |lw(2.75i)
 177 .
 178 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 179 _
 180 Interface Stability     Standard
 181 _
 182 MT-Level        MT-Safe
 183 .TE
 184
 185 .SH SEE ALSO
 186 .sp
 187 .LP
 188 \fBatan\fR(3M), \fBisnan\fR(3M), \fBmath.h\fR(3HEAD), \fBtan\fR(3M),
 189 \fBattributes\fR(5), \fBstandards\fR(5)