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.

mulWide

Multiply a and b. Return type is wide enough to guarantee no overflow.

math.mulWide

pub fn mulWide(comptime T: type, a: T, b: T) @Int(
    @typeInfo(T).int.signedness,
    @typeInfo(T).int.bits * 2,
)

File

lib/std/math.zig:1494

Code

pub fn mulWide(comptime T: type, a: T, b: T) @Int(
    @typeInfo(T).int.signedness,
    @typeInfo(T).int.bits * 2,
) {
    const ResultInt = @Int(
        @typeInfo(T).int.signedness,
        @typeInfo(T).int.bits * 2,
    );
    return @as(ResultInt, a) * @as(ResultInt, b);
}