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
intRangeAtMostBiased
Public Function
std.Random.intRangeAtMostBiased
pubfnintRangeAtMostBiased(r: Random, comptimeT: type, at_least: T, at_most: T) T
Constant-time implementation off intRangeAtMostBiased. The results of this function may be biased.
pubfnintRangeAtMostBiased(r: Random, comptimeT: type, at_least: T, at_most: T) T {
assert(at_least <= at_most);
constinfo = @typeInfo(T).int;
if (info.signedness == .signed) {
// Two's complement makes this math pretty easy.constUnsignedT = @Int(.unsigned, info.bits);
constlo: UnsignedT = @bitCast(at_least);
consthi: UnsignedT = @bitCast(at_most);
constresult = lo +% r.uintAtMostBiased(UnsignedT, hi -% lo);
return@bitCast(result);
} else {
// The signed implementation would work fine, but we can use stricter arithmetic operators here.returnat_least + r.uintAtMostBiased(T, at_most - at_least);
}
}
Constant-time implementation off
intRangeAtMostBiased. The results of this function may be biased.