document how CLVM compression works and its format #527
Conversation
This file contains 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
80d4f79 to
1c9821b
Compare
Pull Request Test Coverage Report for Build 12649089164Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
matt-o-how
reviewed
Jan 6, 2025
1c9821b to
2573ed1
Compare
2573ed1 to
4f8ad15
Compare
4f8ad15 to
bb1dfc8
Compare
richardkiss
reviewed
Jan 7, 2025
richardkiss
reviewed
Jan 7, 2025
docs/compressed-serialization.md
Outdated
| sub-trees). | ||
|
|
||
| We keep popping operations off of the op-stack until it's empty. We take the | ||
| following actions dependin on the operation: |
There was a problem hiding this comment.
Suggested change
| following actions dependin on the operation: | |
| following actions depending on the operation: |
richardkiss
reviewed
Jan 7, 2025
docs/compressed-serialization.md
Outdated
| serialized CLVM tree. To understand what the parse stack is, we first need to | ||
| look at how CLVM is parsed. | ||
|
|
||
| The parser has a stack of _operations_ and a stack of the parsed result (the |
There was a problem hiding this comment.
Suggested change
| The parser has a stack of _operations_ and a stack of the parsed result (the | |
| The parser has a stack of _operations_ and a stack of the parsed results (the |
richardkiss
reviewed
Jan 7, 2025
docs/compressed-serialization.md
Outdated
| bit traversal direction: <- x | ||
| ``` | ||
|
|
||
| A 0 bit means follow the left sub-tree, a 1-bit means follow the right sub-tree. |
There was a problem hiding this comment.
Suggested change
| A 0 bit means follow the left sub-tree, a 1-bit means follow the right sub-tree. | |
| A `0` bit means follow the left sub-tree, while a `1` bit means follow the left sub-tree. |
richardkiss
reviewed
Jan 7, 2025
richardkiss
reviewed
Jan 7, 2025
richardkiss
reviewed
Jan 7, 2025
docs/compressed-serialization.md
Outdated
| ### Example back-reference | ||
|
|
||
| Consider the following LISP structure: ((`1` . `2`) . (`1` . `2`)) | ||
| It Can be serialized as `0xff` `0xff` `1` `2` `0xfe` `0b10` |
There was a problem hiding this comment.
Suggested change
| It Can be serialized as `0xff` `0xff` `1` `2` `0xfe` `0b10` | |
| It can be serialized as `0xff` `0xff` `1` `2` `0xfe` `0b10` |
richardkiss
requested changes
Jan 7, 2025
richardkiss
approved these changes
Jan 7, 2025
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.
This may help further development in this area. There are some optimizations available in both serialization and deserialization.