namegen 0.1.4

Fast name generator.
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
use rand::{Rng};
use crate::{Sample, SampleSet, WorkingSet, LearnError};
use crate::core::ValidationError;
use std::collections::HashSet;

#[derive(Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
pub struct Markov {
    tokens: Vec<String>,
    max_tokens: Vec<usize>,
    starts: Vec<StartNode>,
    total_starts: usize,
    nodes: Vec<Node>,
    lengths: Vec<usize>,
    total_lengths: usize,

    lrs: bool,
    lrm: bool,
    lre: bool,
    rtf: bool,
}

impl Markov {
    #[allow(dead_code)]
    fn print_node(&self, index: usize, depth: usize) {
        if depth == 12 {
            println!("                        ...");
            return;
        }

        let node = &self.nodes[index];

        println!("{}{} l={} w={} e={} i={}", 
            "  ".repeat(depth),
            self.tokens[node.token],
            node.length,
            node.weight,
            node.ending,
            index,
        );

        for child in node.children.iter() {
            self.print_node(*child, depth + 1);
        }
    }
    
    #[allow(dead_code)]
    pub fn print(&self) {
        for start in self.starts.iter() {
            println!("{}{} l={} w={}", 
                self.tokens[start.tokens.0],
                self.tokens[start.tokens.1],
                start.length,
                start.weight,
            );

            for node_index in start.children.iter().cloned() {
                self.print_node(node_index, 1);
            }
        }
    }

    fn find_next_token(&self, remainder: &str) -> Option<usize> {       
        self.tokens.iter().enumerate().skip(1)
                   .filter(|(_, t)| remainder.starts_with(*t))
                   .map(|(i, _)| i )
                   .next()
    }

    fn pick_length(&self, rng: &mut impl Rng) -> usize {
        let mut random = rng.gen_range(0, self.total_lengths);

        3 + self.lengths.iter().enumerate().filter(|(_, s)| {
            if **s > random {
                true
            } else {
                random -= **s;
                false
            }
        }).map(|(i, _)| i).next().unwrap_or(0)
    }

    fn pick_start(&self, rng: &mut impl Rng) -> usize {
        let mut random = rng.gen_range(0, self.total_starts);

        self.starts.iter().enumerate().filter(|(_, s)| {
            if s.weight > random {
                true
            } else {
                random -= s.weight;
                false
            }
        }).map(|(i, _)| i).next().unwrap_or(0)
    }

    /// Generate a name. You need to provide your own WorkingSet and Rng, which is necessary to save
    /// on allocations. A dependent application should use the full name generator interface instead
    pub fn generate(&self, ws: &mut WorkingSet, rng: &mut impl Rng) {
        if self.starts.len() == 0 {
            return
        }

        let mut length = 1;

        ws.stack_pos.clear();
        ws.result.clear();

        while ws.result.len() < length {
            // Start if the stack is empty.
            if ws.stack_pos.len() == 0 {
                let start_index = self.pick_start(rng);
                let start = &self.starts[start_index];

                ws.result.clear();
                ws.stack.clear();

                ws.result.push(start.tokens.0);
                ws.result.push(start.tokens.1);
                ws.stack.extend(start.children.iter());
                ws.stack_pos.push(0);
                ws.stack_weight.push(start.children.iter().map(|ci| self.nodes[*ci].weight).sum());

                length = if self.lrs { start.length } else { self.pick_length(rng) };
            }

            // Get the last one.
            let pos = *ws.stack_pos.last().unwrap();
            let weight = *ws.stack_weight.last().unwrap();
            if ws.stack.len() == pos {
                ws.stack_pos.pop();
                ws.stack_weight.pop();
                ws.result.pop();
                continue;
            }

            // Pick a available child node.
            let mut r = rng.gen_range(0, weight);
            let mut node_index = pos;
            loop {
                let node = &self.nodes[ws.stack[node_index]];
                if r < node.weight {
                    #[cfg(debug_assertions)]
                    assert!(node_index < ws.stack.len());

                    break;
                }

                r -= node.weight;
                node_index += 1;
            }

            let node = &self.nodes[ws.stack[node_index]];
            ws.stack.swap_remove(node_index);
            *ws.stack_weight.last_mut().unwrap() -= node.weight;

            // Only accept endings at the end.
            let ending = ws.result.len() == length - 1;
            if node.ending != ending {
                continue;
            }
            if self.lre && ending && length != node.length {
                continue;
            }

            // Handle token frequency restriction.
            if self.rtf {
                let count = 1 + ws.result.iter().filter(|c| **c == node.token).count();
                if count > self.max_tokens[node.token] {
                    continue;
                }
            }

            // Push the token
            ws.result.push(node.token);
            ws.stack_pos.push(ws.stack.len());
            ws.stack_weight.push(node.children.iter().map(|ci| self.nodes[*ci].weight).sum());
            ws.stack.extend(node.children.iter());
        };

        ws.result_str.clear();
        for s in ws.result.iter().map(|i| &self.tokens[*i]) {
            ws.result_str.push_str(s);
        }
    }

    /// Learn learns samples from the sample set. The former state is copied and will
    /// be restored upon one of the samples failing to import.
    pub fn learn(&mut self, sample_set: &SampleSet) -> Result<(), LearnError>  {
        let old_state = self.clone();
        for sample in sample_set.samples() {
            if let Err(err) = self.learn_norecalc(sample) {
                *self = old_state;
                return Err(err);
            }
        }

        self.recalculate_weights();

        Ok(())
    }

    /// Learn rules from the sample. The generation is heavily optimized for speed, but `learn` is
    /// paying for that speed.
    pub fn learn_one(&mut self, sample: &Sample) -> Result<(), LearnError> {
        if let Err(err) = self.learn_norecalc(sample) {
            return Err(err)
        }

        self.recalculate_weights();

        Ok(())
    }

    fn learn_norecalc(&mut self, sample: &Sample) -> Result<(), LearnError> {
        let sample_string: &str;
        match sample {
            Sample::Word(s) => sample_string = &s,
            Sample::WordWeighted(s, _) => sample_string = &s,
            _ => {
                return Err(LearnError::new(
                    1,
                    format!("Incorrect sample type. Must be Word"),
                    Some(sample.clone()),
                ));
            },
        }

        let mut remainder = sample_string;
        let mut tokens: Vec<usize> = Vec::with_capacity(sample_string.len());

        // Find and learn new tokens.
        while remainder.len() > 0 {
            let token_index;
            if let Some(index) = self.find_next_token(remainder) {
                token_index = index;
                remainder = &remainder[self.tokens[index].len()..];
            } else {
                token_index = self.tokens.len();
                self.tokens.push(String::from(&remainder[0..1]));
                self.max_tokens.push(0);
                remainder = &remainder[1..];
            }

            tokens.push(token_index);
        }
        if tokens.len() < 3 {
            return Err(LearnError::new(
                0,
                format!("3 or more tokens required ({} provided)", tokens.len()),
                Some(sample.clone()),
            ));
        }

        // Learn token frequencies if that is restricted.
        if self.rtf {
            for token in tokens.iter() {
                let count = tokens.iter().filter(|t| **t == *token).count();

                if self.max_tokens[*token] < count {
                    self.max_tokens[*token] = count;
                }
            }
        }

        // Learn start
        let start_tokens = (tokens[0], tokens[1]);
        let start_length = if self.lrs { tokens.len() } else { 0 };
        let start_index;
        if let Some((i, start)) = self.starts.iter_mut().enumerate().find(|(_, s)| s.tokens == start_tokens && s.length == start_length) {
            start_index = i;
            start.weight += 1;
        } else {
            start_index = self.starts.len();
            self.starts.push(StartNode{
                tokens: start_tokens,
                weight: 1,
                length: if self.lrs { tokens.len() } else { 0 },
                children: Vec::with_capacity(8),
            });
        }
        self.total_starts += 1;

        // Learn length
        let length_index = tokens.len() - 3;
        while self.lengths.len() <= length_index {
            self.lengths.push(0);
        }
        self.lengths[length_index] += 1;
        self.total_lengths += 1;

        // Learn rest of name.
        let mut prev = start_tokens;
        let length_m = if self.lrm { tokens.len() } else { 0 };
        let length_e = if self.lre { tokens.len() } else { 0 };
        for (i, token) in tokens.iter().cloned().enumerate().skip(2) {
            let ending = i == (tokens.len() - 1);
            let length = if ending { length_e } else { length_m };
            let current_index;

            if let Some(node_index) = Node::find_current(&self.nodes, prev, token, length, ending) {
                current_index = node_index;
            } else {
                current_index = self.nodes.len();
                self.nodes.push(Node{
                    prev, token, length, ending,
                    children: Vec::with_capacity(8),
                    weight: 1,
                })
            }

            if i > 2 {
                for (_, node) in Node::list_prev(&mut self.nodes, prev, length_m) {
                    if !node.children.contains(&current_index) {
                        node.children.push(current_index);
                    }
                }
            } else {
                if !self.starts[start_index].children.contains(&current_index) {
                    self.starts[start_index].children.push(current_index);
                }
            }

            prev = (prev.1, token);
        }

        Ok(())
    }

    pub fn recalculate_weights(&mut self) {
        let mut round: Vec<usize> = Vec::with_capacity(64);
        let mut next_round: HashSet<usize> = HashSet::new();
        let mut explored: HashSet<usize> = HashSet::new();

        for i in 0..self.nodes.len() {
            if !self.nodes[i].ending {
                continue;
            }

            self.nodes[i].weight = 1;
            next_round.insert(i);
        }

        while next_round.len() > 0 {
            round.clear();
            round.extend(next_round.iter());
            next_round.clear();

            for i in round.iter().cloned() {
                explored.insert(i);

                for j in 0..self.nodes.len() {
                    if self.nodes[j].has_child(i) {
                        self.nodes[j].weight += 1;

                        if !explored.contains(&j) {
                            next_round.insert(j);
                        }
                    }
                }
            }
        }
    }

    pub fn validate(&self) -> Result<(), ValidationError> {
        let total_length: usize = self.lengths.iter().sum();
        if total_length != self.total_lengths {
            return Err(ValidationError::new("parts::Markov", "total_lengths is not accurate."))
        }

        let total_starts: usize = self.starts.iter().map(|s| s.weight).sum();
        if total_starts != self.total_starts {
            return Err(ValidationError::new("parts::Markov", "total_starts is not accurate."))
        }

        for start in self.starts.iter() {
            if start.length == 0 && self.lrs {
                return Err(ValidationError::new("parts::Markov", "start.length cannot be zero if lrs is true."))
            }

            for ch_i in start.children.iter() {
                if *ch_i >= self.nodes.len() {
                    return Err(ValidationError::new("parts::Markov", "start has out of range child."))
                }
            }

            let (st1, st2) = start.tokens;
            if st1 >= self.tokens.len() || st2 >= self.tokens.len() {
                return Err(ValidationError::new("parts::Markov", "start has out of range token."))
            }
        }

        for node in self.nodes.iter() {
            if node.length == 0 && (if node.ending {self.lre} else {self.lrm}) == true {
                return Err(ValidationError::new("parts::Markov", "start.length cannot be zero if lrm/lre is true."))
            }

            for ch_i in node.children.iter() {
                if *ch_i >= self.nodes.len() {
                    return Err(ValidationError::new("parts::Markov", "start has out of range child."))
                }
            }

            if node.token >= self.tokens.len() {
                return Err(ValidationError::new("parts::Markov", "node has out of range token."))
            }

            if node.weight == 0 {
                return Err(ValidationError::new("parts::Markov", "node has zero weight."))
            }

            if node.ending && node.weight != 1 {
                return Err(ValidationError::new("parts::Markov", "ending node cannot have weight <> 1."))
            }

            if node.ending && node.children.len() > 0 {
                return Err(ValidationError::new("parts::Markov", "ending node cannot have children."))
            }

            let (pt1, st2) = node.prev;
            if pt1 >= self.nodes.len() || st2 >= self.nodes.len() {
                return Err(ValidationError::new("parts::Markov", "node has out of range prev."))
            }
        }

        Ok(())
    }

    /// Create a new generator without any pre-defined tokens and constraints.
    pub fn new() -> Markov {
        let tokens: Vec<String> = Vec::new();
        Self::with_constraints(&tokens, false, false, false, false)
    }

    /// Create a new generator with pre-defined tokens and no constraints. The tokens allow you
    /// to define vowel pairs (e.g. ae, ay, ey), digraphs (e.g. th, nth, ng) so that they're treated
    /// as one token.
    pub fn with_tokens<S: AsRef<str>>(tokens: &[S]) -> Markov {
        Self::with_constraints(tokens, false, false, false, false)
    }

    /// Create a new generator with both pre-defined tokens and constraints. The constraints
    /// increases the faithfulness of the generator to the sample material, but at the cost of
    /// variety.
    pub fn with_constraints<S: AsRef<str>>(tokens: &[S], lrs: bool, lrm: bool, lre: bool, rtf: bool) -> Markov {
        Markov{
            tokens: tokens.iter().map(|d| d.as_ref().to_owned()).collect(),
            max_tokens: vec![0usize; tokens.len()],
            nodes: Vec::with_capacity(64),
            starts: Vec::with_capacity(16),
            total_starts: 0,

            lengths: vec![0usize; 8],
            total_lengths: 0,

            lrs, lrm, lre, rtf,
        }
    }
}

#[derive(Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
struct Node {
    #[cfg_attr(feature = "serde", serde(rename="p"))]
    prev: (usize, usize),
    #[cfg_attr(feature = "serde", serde(rename="t"))]
    token: usize,
    #[cfg_attr(feature = "serde", serde(rename="w"))]
    weight: usize,
    #[cfg_attr(feature = "serde", serde(default))]
    #[cfg_attr(feature = "serde", serde(rename="l"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if="is_zero"))]
    length: usize,
    #[cfg_attr(feature = "serde", serde(default))]
    #[cfg_attr(feature = "serde", serde(rename="c"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if="Vec::is_empty"))]
    children: Vec<usize>,
    #[cfg_attr(feature = "serde", serde(default))]
    #[cfg_attr(feature = "serde", serde(rename="e"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if="is_false"))]
    ending: bool,
}

impl Node {
    pub fn has_child(&self, index: usize) -> bool {
        self.children.iter().find(|p| **p == index).is_some()
    }

    fn list_prev(list: &mut [Node], prev: (usize, usize), length: usize) -> impl Iterator<Item=(usize, &mut Node)> {
        list.iter_mut().enumerate().filter(move |(_, n)| n.length == length && n.prev.1 == prev.0 && n.token == prev.1 && n.ending == false)
    }

    fn find_current(list: &[Node], prev: (usize, usize), current: usize, length: usize, ending: bool) -> Option<usize> {
        if length > 0 {
            list.iter().enumerate().filter(|(_, n)| n.length == length && n.ending == ending && n.prev == prev && n.token == current).map(|(i, _)| i).next()        
        } else {
            list.iter().enumerate().filter(|(_, n)| n.ending == ending && n.prev == prev && n.token == current).map(|(i, _)| i).next()                    
        }
    }
}

#[derive(Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
struct StartNode {
    #[cfg_attr(feature = "serde", serde(rename="t"))]
    tokens: (usize, usize),
    #[cfg_attr(feature = "serde", serde(rename="w"))]
    weight: usize,
    #[cfg_attr(feature = "serde", serde(default))]
    #[cfg_attr(feature = "serde", serde(rename="l"))]
    #[cfg_attr(feature = "serde", serde(skip_serializing_if="is_zero"))]
    length: usize,
    #[cfg_attr(feature = "serde", serde(rename="c"))]
    children: Vec<usize>,
}

/// This is only used for serialize
#[allow(clippy::trivially_copy_pass_by_ref, dead_code)]
fn is_false(v: &bool) -> bool {
    !*v
}

/// This is only used for serialize
#[allow(clippy::trivially_copy_pass_by_ref, dead_code)]
fn is_zero(v: &usize) -> bool {
    *v == 0
}