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
Randomly selects an index into proportions, where the likelihood of each index is weighted by that proportion. It is more likely for the index of the last proportion to be returned than the index of the first proportion in the slice, and vice versa.
This is useful for selecting an item from a slice where weights are not equal. T must be a numeric type capable of holding the sum of proportions.
pubfnweightedIndex(r: Random, comptimeT: type, proportions: []constT) usize {
// This implementation works by summing the proportions and picking a// random point in [0, sum). We then loop over the proportions,// accumulating until our accumulator is greater than the random point.constsum = s: {
varsum: T = 0;
for (proportions) |v| sum += v;
break :ssum;
};
constpoint = switch (@typeInfo(T)) {
.int => |int_info| switch (int_info.signedness) {
.signed => r.intRangeLessThan(T, 0, sum),
.unsigned => r.uintLessThan(T, sum),
},
// take care that imprecision doesn't lead to a value slightly greater than sum
.float => @min(r.float(T) * sum, sum - std.math.floatEps(T)),
else => @compileError("weightedIndex does not support proportions of type " ++
@typeName(T)),
};
assert(point < sum);
varaccumulator: T = 0;
for (proportions, 0..) |p, index| {
accumulator += p;
if (point < accumulator) returnindex;
} elseunreachable;
}
Randomly selects an index into
proportions, where the likelihood of each index is weighted by that proportion. It is more likely for the index of the last proportion to be returned than the index of the first proportion in the slice, and vice versa.This is useful for selecting an item from a slice where weights are not equal.
Tmust be a numeric type capable of holding the sum ofproportions.