Zig 0.17.0-dev (Split by item)

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 library itself.

atan2

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

atan2.atan2

pub fn atan2(y: anytype, x: anytype) @TypeOf(x, y)

File

lib/std/math/atan2.zig:33

Code

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)),
    };
}