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

mod

Public Function
std.math.mod
pub fn mod(comptime T: type, numerator: T, denominator: T) !T

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

Params

  • T: type
  • numerator: T
  • denominator: T

File

math.zig:994
994
995
996
997
998
999
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);
}