panoradix 0.3.4

A generic map and a set, both backed by a Radix tree.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

panoradix
=========

![Travis badge](https://travis-ci.org/jmcomets/panoradix.svg?branch=master)
![crates.io badge](https://img.shields.io/crates/v/panoradix.svg)

My take on implementing a [Radix tree][], for usage when large data mappings with
strings as indices.

Note: this is currently a **work in progress**, expect unannounced brutal API
changes every time the version is bumped.

## What's in this repo?

- [RadixMap][], a key-value map where the key is necessarily a string.
- [RadixSet][], a set of strings.

Both are backed by a [Radix tree][].

## What's being worked on?

A lot is missing right now, here's a wishlist sorted by difficulty/want:

- [ ] map iterators: `values_mut()`
- [ ] faster edge search: currently linear, should probably be binary search
- [ ] erasing a key: should be straightforward
- [ ] intersection: should be straightforward
- [ ] union: since there can't be multiple values, merging two values with the
             same key should be annoying
- [ ] take arbitrary keys instead of strings: had a go trying to implement this
      early on, but the API transparency between `&str` and `String` is so damn
      gorgeous that I've postponed this indefinitely

### What's just been finished?

- [x] set iterators: `keys()`
- [x] map iterators: `keys()`, `values()`

[RadixMap]: https://github.com/jmcomets/panoradix/blob/master/src/map.rs
[RadixSet]: https://github.com/jmcomets/panoradix/blob/master/src/set.rs

[Radix tree]: https://en.wikipedia.org/wiki/Radix_tree