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.

uintAtMost

Returns an evenly distributed random unsigned integer 0 <= i <= at_most. See uintLessThan, which this function uses in most cases, for commentary on the runtime of this function.

Random.uintAtMost

pub fn uintAtMost(r: Random, comptime T: type, at_most: T) T

File

lib/std/Random.zig:202

Code

pub fn uintAtMost(r: Random, comptime T: type, at_most: T) T {
    assert(@typeInfo(T).int.signedness == .unsigned);
    if (at_most == maxInt(T)) {
        // have the full range
        return r.int(T);
    }
    return r.uintLessThan(T, at_most + 1);
}