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.

mod

Returns numerator modulo denominator, or an error if denominator is zero or negative. Negative numerators never result in negative return values.

math.mod

pub fn mod(comptime T: type, numerator: T, denominator: T) !T

File

lib/std/math.zig:994

Code

pub fn mod(comptime T: type, numerator: T, denominator: T) !T {
    @setRuntimeSafety(false);
    if (denominator == 0) return error.DivisionByZero;
    if (denominator < 0) return error.NegativeDenominator;
    return @mod(numerator, denominator);
}