docs+: P3 transparency cleanup (round-bankers, rd.log(-inf), stale docs)#54
Merged
Conversation
Doc/comment fixes plus two trivial correctness one-liners (with tests): math.hoon: - round-bankers actually rounds half-to-EVEN now (was half-up: it took the already-rounded toi result and bumped ties up, so round-bankers 2.5 -> 3). toi under %n ties to even, so force ^rs/^rd %n. +test-round-bankers. - rd.log(-inf) returns NaN (was 0.0 -- a copy-paste from exp; rs was already correct). Fixed the stray "exp(...)" comments in the rd.log branch. +test-log-ninf. - tiny (rs/rh) docstrings/examples said "smallest normal" but the value is the smallest SUBNORMAL (2^-149 / 2^-24); corrected, with a pointer to the normal. sur/lagoon.hoon: - %cplx comment listed @cs/@cd; four widths ship (@ch/@cs/@cd/@cq). - augmented the `tail=*` comment to explain it's deliberate per-kind specialization space (slots in without rewriting jet axes; %fixp uses it). lagoon.hoon: documented +check (the 0x1-pin / shape invariant) and the known %i754->%uint negative-value limitation (was a bare XXX). saloon.hoon: +neq doccord said "equal to" -> "not equal to"; fixed the `data=data=` typos in the gth/gte/geq examples. READMEs: lagoon Type System refreshed (%real -> %i754; all six kinds shipped, not "planned"); saloon README gains a linear-algebra (eig/eigvals/eigvecs) section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
ed46f64 to
ca42387
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
P3 — docs/traceability batch (Gnome/Angel review)
Mostly comments/docstrings/READMEs, plus two trivial correctness one-liners with tests.
Behavioral (with tests) —
math.hoonround-bankersnow actually rounds half-to-even. It was half-up: it took the already-toi-rounded value and bumped ties up, soround-bankers(2.5)→ 3 (not 2).toiunder%nties to even, so force^rs/^rd %n. →test-round-bankers(2.5→2, 1.5→2, 3.5→4).rd.log(-inf)returns NaN (was0.0— a copy-paste fromexp;rs.logwas already correct). Also fixed the strayexp(...)comments in therd.logbranch. →test-log-ninf.Docs / comments
math.hoontiny(rs/rh): docstring/example said "smallest normal" but the value is the smallest subnormal (2^-149/2^-24) — corrected, with a pointer to the normal.sur/lagoon.hoon:%cplxlisted@cs/@cd→ now@ch/@cs/@cd/@cq; augmented thetail=*comment to explain it's deliberate per-kind specialization space (slots in without rewriting jet axes — per the design rationale;%fixpuses it for precision).lagoon.hoon: documented+check(the0x1-pin /prod(shape)invariant every public arm relies on) and the known%i754→%uintnegative-value limitation (was a bareXXX).saloon.hoon:+neqdoccord said "equal to" → "not equal to"; fixed thedata=data=typos in thegth/gte/geqexamples.%real→%i754; all six kinds shipped, not "planned"); saloon gains a linear-algebra (eig/eigvals/eigvecs) section.All edits are in regions disjoint from the open PRs (#50–#53), so no conflicts expected.
math.hoon,lagoon.hoon,saloon.hoonall rebuild green; the newmath-roundingtests pass.(Deferred to the #18 Chebyshev rewrite, already noted there: the
loghang,expcancellation,asin/acos&sqt(-0)crashes, and the no-op NaN guards.)🤖 Generated with Claude Code