pruning_radix_trie 1.0.0

Rust implementation of Pruning Radix Trie, originally by Wolf Garbe
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56

# Pruning Radix Trie
Rust implementation of [Pruning Radix Trie, originally by Wolf Garbe](https://github.com/wolfgarbe/PruningRadixTrie) (see credits/PruningRadixTrieLicense.txt).

## Usage
Add terms with payloads to the trie with:
```rust
pub fn add(&mut self, term: &str, payload: T, weight: U);
```
After which you can prefix match with:
```rust
pub fn find(&self, prefix: &str, top_k: usize) 
    -> Vec<(String, &T, &U)>
```
Results are returned in descending order based on weight.

## Example
```rust
use pruning_radix_trie::PruningRadixTrie;

fn main() {
    let mut trie = PruningRadixTrie::new();
    trie.add("heyo", vec![1, 2, 3], 5);
    trie.add("hello", vec![4, 5, 6], 10);
    trie.add("hej", vec![7, 8, 9], 20);

    let results = trie.find("he", 10);

    for Result { term, payload, weight } in results {
        println!("{:10}{:?}{:>4}", term, payload, weight);
    }
    //hej       [7, 8, 9]  20
    //hello     [4, 5, 6]  10
    //heyo      [1, 2, 3]   5
}
```
## Testing
### Measuring code coverage

N.B.: At the moment, the nightly channel of Rust is required.

First of all, install grcov
```sh
cargo install grcov
```

Second, install the llvm-tools Rust component (`llvm-tools-preview` for now, it might become `llvm-tools` soon):
```sh
rustup component add llvm-tools-preview
```
To run tests with code coverage run
```
bash run_source_cov.sh
```
A html coverage report will be generated in `./target/debug/coverage/`

See [rust-code-coverage-sample](https://github.com/marco-c/rust-code-coverage-sample) for details.