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
intRangeLessThanBiased
Public Function
std.Random.intRangeLessThanBiased
pubfnintRangeLessThanBiased(r: Random, comptimeT: type, at_least: T, less_than: T) T
Constant-time implementation off intRangeLessThan. The results of this function may be biased.
pubfnintRangeLessThanBiased(r: Random, comptimeT: type, at_least: T, less_than: T) T {
assert(at_least < less_than);
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(less_than);
constresult = lo +% r.uintLessThanBiased(UnsignedT, hi -% lo);
return@bitCast(result);
} else {
// The signed implementation would work fine, but we can use stricter arithmetic operators here.returnat_least + r.uintLessThanBiased(T, less_than - at_least);
}
}
Constant-time implementation off
intRangeLessThan. The results of this function may be biased.