Improve documentation fix type of deflate window #116
Merged
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
|
As far as I can tell, |
kit-ty-kate
pushed a commit
to ocaml/opam-repository
that referenced
this pull request
Apr 22, 2021
CHANGES: - Add a well-know limitation about the encoding on the documentation, the output buffer must be upper than 2 bytes in any cases. (@dinosaure, mirage/decompress#114) - Improve the documentation (@dinosaure, @brendanlong, mirage/decompress#115) - **breaking changes**, the type of the window used to deflate according RFC 1951 was updated to `De.Lz77.window` (@dinosaure, mirage/decompress#116 & mirage/decompress#115) - Fix a bug when we want to add the EOB _op-code_ into the queue. The deflation takes care about that. Note that the queue must be larger than 2. (@dinosaure, @kluvin, mirage/decompress#117) - Improve the documentation a bit (@mseri, @dinosaure, mirage/decompress#119) - Fix the use of `optint` and how we handle large files with `Gz`. Fix an error when we encode the `isize` into the deflated stream. (@dinosaure, @igarnier, mirage/decompress#121 & mirage/decompress#120) - Add a _non-stream_ implementation (@clecat, @dinosaure, mirage/decompress#102 & mirage/decompress#92) The non-blocking stream API has a cost to maintain a _state_ across _syscall_ such as `read` and `write`. It's useful when we want to plug `decompress` behind something like a `socket` and care about memory-consumption but it has a big cost when we want to compress/decompress an object saved into one and unique buffer. The _non-stream_ API gives an opportunity to inflate/deflate one and unique buffer without the usual plumbing required by the non-blocking stream API. However, we are limited to compute only objects which can fit into a `bigarray`. About performance, the non-stream API is better than the non-blocking stream API. See the PR for more details about performances. On the `book2` (from the Calgary corpus) file: - `decompress` (stream): 15 Mb/s (deflation), 76 Mb/s (inflation), ratio: 42.46 % - `decompress` (non-stream): 17 Mb/s (deflation), 105 Mb/s (inflation), ratio: 34.66 % Even if we checked the implementation with our tests (we ran `ocaml-git` and `irmin` with this path), the implementation is young and we probably miss some details/bugs. So we advise the user to compare, at least, the non-stream implementation with the non-blocking stream implementation if something is wrong.
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.
See #115