poetrie 2.2.0

Poetic trie crafted with intention to ease searching of rhymes for poems.
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

## POETRIE

Poetrie means poetic trie. Poetrie is designated for searching common suffixes of words.

### Usage

<h4><u>Classic Use Case</u></h4>

Note configuration to match behavior communicated via `MatchConduct` structure.

```rust
let mut poetrie = Poetrie::nw();
let words = [
    "analytics",
    "metrics",
    "ethics",
    "Acoustics",
    "antics",
    "topics",
    "anticruelty",
]
.map(Key::new_from_str)
.map(Option::unwrap);

for w in words {
    poetrie.it(&w);
}

let mc = MatchConductShaper::init()
    .max_n(usize::MAX) // unlimited matches count
    .max_sl(3) // only 'ics' or less but not '…rics'
    .max_ml(8) // only 8 or less length matches
    .form()
    .unwrap();

let probe = Key::new_from_str("lyrics").unwrap();
let matchee = poetrie.sx(&probe, &mc);

let confirmation: HashSet<String> =
    ["ethics", "antics", "topics"].map(String::from).into();

let matchee = matchee.unwrap_or_default();
for m in matchee.iter() {
    assert!(confirmation.contains(m));
}
assert_eq!(confirmation.len(), matchee.len());

let mc = MatchConduct::default();

let probe = Key::new_from_str("anticruelty").unwrap();
assert_eq!(Err(FindErr::OnlyKeyMatches), poetrie.sx(&probe, &mc));

let probe = Key::new_from_str("solemn").unwrap();
assert_eq!(Err(FindErr::NoJointSuffix), poetrie.sx(&probe, &mc));
```

<h4><u>Handy Use Case</u></h4>

Thinking about what could be good rhyming with word of choice, simple try search for that suffix directly. Let say, having _"lyrics"_ as word without match, thinking it should rhyme with something ending with _"ynx"_. 

```rust
let mut poetrie = Poetrie::nw();
let words = ["lynx", "index"].map(Key::new_from_str).map(Option::unwrap);

for w in words {
    poetrie.it(&w);
}

let probe = Key::new_from_str("ynx").unwrap();
let mc = MatchConduct::default();
let matchee = poetrie.sx(&probe, &mc);

assert_eq!(Ok(vec![String::from("lynx")]), matchee);
```

Now, one goes: _"As the paws in a snow, </br>
laid down by lightening lynx, </br>
my word goes there and forth, </br>
composing the aerial lyrics."_.