xref: /openbsd/lib/libm/man/atan2.3 (revision f6aab3d8)
1.\"	$OpenBSD: atan2.3,v 1.20 2021/06/29 14:47:33 schwarze Exp $
2.\" Copyright (c) 1991 The Regents of the University of California.
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\" 3. Neither the name of the University nor the names of its contributors
14.\"    may be used to endorse or promote products derived from this software
15.\"    without specific prior written permission.
16.\"
17.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27.\" SUCH DAMAGE.
28.\"
29.\"     from: @(#)atan2.3	5.1 (Berkeley) 5/2/91
30.\"
31.Dd $Mdocdate: June 29 2021 $
32.Dt ATAN2 3
33.Os
34.Sh NAME
35.Nm atan2 ,
36.Nm atan2f ,
37.Nm atan2l
38.Nd arc tangent functions of two variables
39.Sh SYNOPSIS
40.In math.h
41.Ft double
42.Fn atan2 "double y" "double x"
43.Ft float
44.Fn atan2f "float y" "float x"
45.Ft long double
46.Fn atan2l "long double y" "long double x"
47.Sh DESCRIPTION
48The
49.Fn atan2
50function computes the principal value of the arc tangent of
51.Fa y Ns / Ns Fa x ,
52using the signs of both arguments to determine the quadrant of
53the return value.
54The
55.Fn atan2f
56function is a single precision version of
57.Fn atan2 .
58The
59.Fn atan2l
60function is an extended precision version of
61.Fn atan2 .
62.Sh RETURN VALUES
63The
64.Fn atan2 ,
65.Fn atan2f
66and
67.Fn atan2l
68functions, if successful,
69return the arc tangent of
70.Fa y Ns / Ns Fa x
71in the range
72.Bk -words
73.Bq \&- Ns pi , \&+ Ns pi
74.Ek
75radians.
76If both
77.Fa x
78and
79.Fa y
80are zero, the global variable
81.Va errno
82is set to
83.Er EDOM .
84.Sh SEE ALSO
85.Xr acos 3 ,
86.Xr asin 3 ,
87.Xr atan 3 ,
88.Xr cos 3 ,
89.Xr cosh 3 ,
90.Xr sin 3 ,
91.Xr sinh 3 ,
92.Xr tan 3 ,
93.Xr tanh 3
94.Sh STANDARDS
95The
96.Fn atan2
97function conforms to
98.St -ansiC .
99