Update README and changelog for the inline-value representation#44
Merged
Conversation
The docs still described the pre-inlining design and mis-stated the new one: - README's technical sections described the deleted 512-entry static integer array, a 2-bit tag with 4-byte alignment, and "24-bit heap allocation" for small integers, and claimed arbitrary-precision numbers were not supported. - The README's INumber section and the CHANGELOG both said inline numbers are an exact decimal (`mantissa * 10^exp`). That is only true with `arbitrary_precision`; by default the inline slot is a base-2 binary float (`mantissa * 2^exp`), so every inline number is exactly an `f64`. Rewrite the README's IValue/INumber/IString technical and usage sections for the 3-bit tag / 8-byte alignment scheme, inline small values (`mantissa * base^exp`, base 2 by default and base 10 under the feature), and inline short strings. Fix the changelog's inline-number wording and add the missing `arbitrary_precision` feature entry. Docs only; no code changes.
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
1 participant
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.
Documentation only — no code changes. Brings the README and changelog in line with the inline-value representation merged in #42/#43.
The docs still described the pre-inlining design, and in one place mis-stated the new one:
INumbersection and the changelog both described inline numbers as an exact decimal (mantissa * 10^exp). That is only true witharbitrary_precision; by default the inline slot is a base-2 binary float (mantissa * 2^exp), so every inline number is exactly anf64.Changes
README
IValuetechnical section: 3-bit tag / 8-byte alignment; seven pointer tags plus the inline family (tag 0), rather than "4 heap types / 2 bits" and the0x1/0x2/0x3constant pointers.INumbertechnical + usage sections: inlinemantissa × base^expnumbers (base 2 by default → always exactly anf64; base 10 underarbitrary_precision→ exact decimal), 56-bit mantissa (24-bit on 32-bit), 8-byte heap spill — replacing the static-array description and the "i8/u8 no-alloc, 24-bit 4-byte-alloc" claims.IString: short strings are stored inline; longer strings are interned.CHANGELOG (
0.1.7)arbitrary_precisionfeature entry.