Stdlib: Binary/Byte stream utilities #923
Open
Conversation
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
marvinborner
reviewed
Apr 1, 2025
jiribenes
reviewed
Apr 1, 2025
|
Another use case is https://github.com/effekt-community/effekt-rejit/ . |
marzipankaiser
force-pushed
the
stdlib/binstream
branch
from
cf907f6 to
96c0eed
Compare
jiribenes
reviewed
May 2, 2025
|
Broken on LLVM, by Valgrind and missing generic stuff (for tests) |
marzipankaiser
force-pushed
the
stdlib/binstream
branch
from
0792602 to
a2f38de
Compare
jiribenes
added a commit
that referenced
this pull request
May 6, 2025
Tiny & fast exponentiation using streams: <img width="491" alt="Screenshot 2025-04-05 at 16 04 07" src="https://github.com/user-attachments/assets/0ec1cdf1-6c86-4fa4-890f-063540c083f4" /> The approach is simple: to calculate `n^k`, zip squares of `n` (`n`, `n^2`, `n^4`, ...) with the bits of `k`. Sketch: ``` n^k = n^0b10011 = (1 * n^0b10000) * (0 * n^0b01000) * (0 * n^0b00100) * (1 * n^0b00010) * (1 * n^0b00001) ``` Also drags a few other changes along: - `product` and `iterate` in `stream` - temporary addition of `eachLSB` and `eachMSB` -- these would probably be better off using the toolchain from #923, but I don't want to forget about the example I'm adding it because: 1. it's a fun, small example, 2. it uses a bunch of different combinators, 3. it uses the new multiple param lambda case syntax (#914), 4. and it has some missed opt opportunities, I think.
timsueberkrueb
added a commit
that referenced
this pull request
May 7, 2025
The generated identifiers in the IR seem non-deterministic between execution environments: one can observe different names locally vs on the CI. This led to test failures in entirely unrelated PRs (#930, #923). As this is blocking the other PRs, I propose the hotfix contained in this PR. I'm also open to better suggestions on how to write this particular test case or on how to fix the non-determinism.
marzipankaiser
force-pushed
the
stdlib/binstream
branch
from
dfeb01b to
1f24f64
Compare
Co-authored-by: Jiří Beneš <[email protected]>
marzipankaiser
force-pushed
the
stdlib/binstream
branch
from
1f24f64 to
d5c61a8
Compare
jiribenes
approved these changes
May 12, 2025
| @@ -0,0 +1,349 @@ | |||
| import option | |||
There was a problem hiding this comment.
Naming 🚲 🏠
- Should this be a top-level module like
binstreamor a nested one likestream/binary/stream/bin...? - Is it a binary stream or a bit stream?
There was a problem hiding this comment.
- I do not care. It could be nested.
- It is byte and bit streams. So, very much open to suggestions.
| } | ||
| with splice[OfWidth[BE[Signed[Int]]]] { i => | ||
| collectList[Bit]{ | ||
| if(i.raw.raw.raw < 0){ |
There was a problem hiding this comment.
My kingdom for newtypes? :)
There was a problem hiding this comment.
Yes. It is somewhat nice use-wise, but this really should be something like a newtype - or us adding formatting specifiers to splices in some other form.
examples/stdlib/binstream.effekt
Outdated
| test("int back-and-forth (17), explicit BE"){ assert(x"${17.BE}", 17) } | ||
| test("int back-and-forth (17), explicit LE"){ assert(x"${17.LE}", 17 * 256 * 256 * 256) } | ||
| test("byte 00101010"){ | ||
| with on[MissingValue].default{ assert(true, false) } |
There was a problem hiding this comment.
Since we're changing test anyway, could we add a on[MissingValue].assertSome?
There was a problem hiding this comment.
Yes, good idea. TODO.
There was a problem hiding this comment.
effekt/libraries/common/test.effekt
Lines 62 to 73 in 3d973b2
WDYT?
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 adds a
binstreamfile to the stdlib that can be used to easily create streams of bytes.See #870 for a usage example (this was mostly factored out from there).