haskell / bytestring

An efficient compact, immutable byte string type (both strict and lazy) suitable for binary or 8-bit character data.
http://hackage.haskell.org/package/bytestring
Other
286 stars 137 forks source link

Offer conversion with `Natural`. #678

Open kindaro opened 2 months ago

kindaro commented 2 months ago

A task one sometimes has to deal with is to take a number and look at the bytes it is made of. In other words, a number can be seen as an array of bytes. Specifically, there is a one to one inlay of numbers into byte strings and its inverse from byte strings back to numbers. It would be convenient if such a pair of functions could be found in this package.

There are two ways to encode a number into an array: least or most significant bit first. We can pick whichever is faster. There is also some confusion as to whether the encoding of 0 should be an empty byte string or a lonely zero byte. Neither is more mathematically principled than the other — we can pick whichever is more handy for our algorithm.

I think there is a linear time algorithm for either most significant or least significant digit first. But we can talk about implementation details once the design is agreed upon.

clyring commented 2 months ago

ghc-bignum provides some primitives along these lines. See naturalToAddr and naturalFromAddr (and their ByteArray# analogues) in GHC.Num.Natural.

integer-simple is not so kind, though its representation does allow repeated shifts and integerToWord calls to extract the bytes in linear time. But it's probably not worth fiddling with the older bignum libraries at all.