You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reader feedback: the term "sb_add" is used in the History section of
docs/number-systems/lns.md and in the cost-comparison table before it
is formally defined in the How section -- and "sb_" itself is opaque
because it does not stand for anything in the LNS literature. It was
introduced as Universal's internal C++ API prefix when the
configurable add/sub framework landed in PR #784, without an inline
definition.
Fixes:
1. docs/number-systems/lns.md (Introduction):
- History section: replace "sb_add" with descriptive prose
("approximation for the log-add correction") so the term is not
used before its definition
- Operation cost comparison table: same -- "Transcendental sb_add"
-> "Transcendental log-add correction"
- How section: add a "Naming convention" callout box where the
formal definition is given. The callout:
- states the formula (sb_add(d) = log2(1 + 2^d), sb_sub(d) =
log2(1 - 2^d))
- explains that "sb_" reads as "sum-base" and is Universal's
internal C++ API prefix
- cites the LNS literature equivalents (Coleman et al.'s
phi(z) / psi(z), Arnold et al.'s F+(d) / F-(d))
- clarifies that the mathematics is identical; only symbol choice
differs
2. docs/number-systems/lns-addsub-algorithms.md (intro paragraph):
- First reference now also defines sb_sub, and links to the
Naming convention callout in the introduction page.
3. docs/number-systems/lns-tolerance-traits.md (boundary-rounding
problem):
- First reference adds a brief reminder of the formula and a link
to the introduction's Naming convention callout.
4. docs/design/lns-add-sub.md (the canonical design doc):
- Same Naming convention callout added at the point where sb_add
and sb_sub are first formally defined.
- Drive-by: replace one residual em dash with the ASCII " -- " in
the same paragraph (matches the project's ASCII-only convention).
The C++ API names (sb_add, sb_sub) are unchanged. Renaming the API to
match the literature (phi/psi or F+/F-) was considered but rejected
as out-of-scope churn -- the prefix has shipped through PRs #784-#788
and is now part of the policy class API contract. Documenting what it
means is the right pragmatic call.
Verified: docs-site sync runs cleanly, full astro build produces 80
pages, all 5 affected files are ASCII-only.
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
0 commit comments