luikore / triez

fast, efficient, unicode aware HAT trie with prefix / suffix support for Ruby
MIT License
140 stars 9 forks source link

Improve hat-trie readability? #4

Open canadaduane opened 10 years ago

canadaduane commented 10 years ago

I'm really excited to work on this some more. How would you feel about my making some documentation and variable name changes to the hat-trie code? For instance, it took me a while to figure out that ".b" is referring to "bucket" and ".t" is a "trie_node". I think it would help newcomers to this codebase. Should I approach dcjones about his code base? I almost think these (your hat-trie fork and his) should be merged, since you've added a lot of value with your fork. Then my additions (notes, variables names, etc.) would help both code bases.

luikore commented 10 years ago

I agree that the code is quite hard to read, and there are some unnecessary hand-crafted optimizations that worsen the readability while provides nothing to speed since many compilers can also do the same job.

I haven't checked the changes of original repo for a long time, I'd like to rebase this repo to create a pull request on the original one but I'm afraid changes are too much. Also, issues like API need to be discussed first...

I think you should start with the original code base? It can be much easier once you have read the articles to understand how the HAT-Trie works. Good luck!