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
pubfnaddSat(r: *Mutable, a: Const, b: Const, signedness: Signedness, bit_count: usize) void {
constreq_limbs = calcTwosCompLimbCount(bit_count);
// Slice of the upper bits if they exist, these will be ignored and allows us to use addCarry to determine// if an overflow occurred.constx: Const = .{
.positive = a.positive,
.limbs = a.limbs[0..@min(req_limbs, a.limbs.len)],
};
consty: Const = .{
.positive = b.positive,
.limbs = b.limbs[0..@min(req_limbs, b.limbs.len)],
};
if (r.addCarry(x, y)) {
// There are two possibilities here:// - We overflowed req_limbs, in which case we need to saturate.// - a and b had less elements than req_limbs, and those were overflowed.// Note: In this case, might _also_ need to saturate.constmsl = @max(a.limbs.len, b.limbs.len);
if (msl < req_limbs) {
r.len = msl + 1;
r.limbs[msl] = 1;
// Note: Saturation may still be required if msl == req_limbs - 1
} else {
// Overflowed req_limbs, definitely saturate.returnr.setTwosCompIntLimit(if (r.positive) .maxelse .min, signedness, bit_count);
}
}
// Saturate if the result didn't fit.r.saturate(r.toConst(), signedness, bit_count);
}
r = a + b with 2s-complement saturating semantics. r, a and b may be aliases.
Assets the result fits in
r. Upper bound on the number of limbs needed by r iscalcTwosCompLimbCount(bit_count).