search

Priyash / xxhash

Automatically exported from code.google.com/p/xxhash
Other
0 stars 0 forks source link

Document xxhash #13

Open GoogleCodeExporter opened 8 years ago

GoogleCodeExporter commented 8 years ago 
Would be possible have a small document with the algorithm specification?

Original issue reported on code.google.com by luca.bar...@gmail.com on 18 Sep 2013 at 9:24

GoogleCodeExporter commented 8 years ago 
Not sure about what you call an algorithm specification.
Do you have an example ?

Original comment by yann.col...@gmail.com on 18 Sep 2013 at 9:30

GoogleCodeExporter commented 8 years ago 
Since we are talking about an hash function it should be as simple as
describing it in English

- The function works on block of size ${size}, incomplete blocks are
padded with ${pattern}
- The function keeps a state
  - ...
- The function has the following stages
  - ...

And such, here the wikipedia page for crc computation.

http://en.wikipedia.org/wiki/Computation_of_CRC

Probably you wrote something like that for lz4 and I didn't notice.

Original comment by luca.bar...@gmail.com on 18 Sep 2013 at 10:12

GoogleCodeExporter commented 8 years ago 
OK, clear enough,

I did not write something equivalent for xxHash.
For the time being, the code is its own documentation.

Writing an elaborate description of the hash function is a quite significant 
work. 
I can't commit enough free time to do it right now.
Such a description is likely to be redacted sometimes in the future, but I 
don't know when.

Original comment by yann.col...@gmail.com on 18 Sep 2013 at 11:19

GoogleCodeExporter commented 8 years ago 
I opened the issue so I do not forget mostly, I wouldn't expect to
have it written now.

If the code is expected not to change I can use it just fine to
reimplement the algorithm.

Original comment by luca.bar...@gmail.com on 18 Sep 2013 at 3:41

GoogleCodeExporter commented 8 years ago 
OK, sure,
btw, the algorithm is now considered stable.
It has to be, since it is used in a public format to transmit data.
Any future evolution will have to produce strictly the same results.

Original comment by yann.col...@gmail.com on 18 Sep 2013 at 3:43

GoogleCodeExporter commented 8 years ago

Original comment by yann.col...@gmail.com on 9 May 2014 at 11:32

GoogleCodeExporter commented 8 years ago

Original comment by yann.col...@gmail.com on 11 Jul 2014 at 11:49