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.

sqrt

Returns the square root of z. The real and imaginary parts of the result have the same sign as the imaginary part of z.

sqrt.sqrt

pub fn sqrt(z: anytype) Complex(@TypeOf(z.re, z.im))

File

lib/std/math/complex/sqrt.zig:15

Code

pub fn sqrt(z: anytype) Complex(@TypeOf(z.re, z.im)) {
    const T = @TypeOf(z.re, z.im);

    return switch (T) {
        f32 => sqrt32(z),
        f64 => sqrt64(z),
        else => @compileError("sqrt not implemented for " ++ @typeName(T)),
    };
}