Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Function

atan2

Public Function
std.math.atan2.atan2
pub fn atan2(y: anytype, x: anytype) @TypeOf(x, y)

Returns the arc-tangent of y/x.

Special Cases:

y x radians
fin nan nan
nan fin nan
+0 >=+0 +0
-0 >=+0 -0
+0 <=-0 pi
-0 <=-0 -pi
pos 0 +pi/2
neg 0 -pi/2
+inf +inf +pi/4
-inf +inf -pi/4
+inf -inf 3pi/4
-inf -inf -3pi/4
fin +inf 0
pos -inf +pi
neg -inf -pi
+inf fin +pi/2
-inf fin -pi/2

Params

  • y
  • x

File

math/atan2.zig:33
33
34
35
36
37
38
39
40
pub fn atan2(y: anytype, x: anytype) @TypeOf(x, y) {
    const T = @TypeOf(x, y);
    return switch (T) {
        f32 => atan2_32(y, x),
        f64 => atan2_64(y, x),
        else => @compileError("atan2 not implemented for " ++ @typeName(T)),
    };
}