evolve 0.4.0

A generic, composable genetic algorithm framework for Rust
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

//! The [`GrammarDef`] trait abstracting grammar access for the mapper.

use crate::grammar::{Grammar, Symbol};

/// Trait abstracting grammar access for the mapper.
///
/// Both the built-in [`Grammar`] struct and user-defined types can implement
/// this to work with `map()`.
///
/// # Examples
///
/// ```
/// use evolve::grammar::Grammar;
/// use evolve::grammar::grammar_def::GrammarDef;
///
/// let grammar = Grammar::builder()
///     .rule("s", &[&["a"], &["b"]])
///     .start("s")
///     .build();
///
/// let start = GrammarDef::start(&grammar);
/// assert_eq!(grammar.num_productions(start), 2);
/// ```
pub trait GrammarDef {
    /// The type used to identify symbols.
    type Symbol: Copy;

    /// The terminal value type.
    type Terminal: Clone;

    /// Returns the start symbol.
    fn start(&self) -> Self::Symbol;

    /// Returns the number of productions for a non-terminal symbol.
    /// Returns 0 for terminals.
    fn num_productions(&self, symbol: Self::Symbol) -> usize;

    /// Returns the symbols in a specific production of a rule.
    fn production(&self, symbol: Self::Symbol, index: usize) -> &[Self::Symbol];

    /// Returns true if the symbol is a terminal.
    fn is_terminal(&self, symbol: Self::Symbol) -> bool {
        self.num_productions(symbol) == 0
    }

    /// Returns the terminal value for a terminal symbol.
    fn terminal_value(&self, symbol: Self::Symbol) -> Self::Terminal;
}

impl<T: Clone> GrammarDef for Grammar<T> {
    type Symbol = Symbol;
    type Terminal = T;

    fn start(&self) -> Symbol {
        Symbol::NonTerminal(self.start())
    }

    fn num_productions(&self, symbol: Symbol) -> usize {
        match symbol {
            Symbol::Terminal(_) => 0,
            Symbol::NonTerminal(i) => self.rules()[i].productions.len(),
        }
    }

    fn production(&self, symbol: Symbol, index: usize) -> &[Symbol] {
        match symbol {
            Symbol::NonTerminal(i) => &self.rules()[i].productions[index],
            Symbol::Terminal(_) => &[],
        }
    }

    fn is_terminal(&self, symbol: Symbol) -> bool {
        matches!(symbol, Symbol::Terminal(_))
    }

    fn terminal_value(&self, symbol: Symbol) -> T {
        match symbol {
            Symbol::Terminal(idx) => self.terminals()[idx].clone(),
            _ => panic!("terminal_value called on non-terminal"),
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    fn simple_grammar() -> Grammar<&'static str> {
        Grammar::builder()
            .rule("s", &[&["a"], &["b"], &["c"]])
            .start("s")
            .build()
    }

    #[test]
    fn start_returns_non_terminal() {
        let g = simple_grammar();
        assert_eq!(GrammarDef::start(&g), Symbol::NonTerminal(0));
    }

    #[test]
    fn num_productions_for_terminal() {
        let g = simple_grammar();
        assert_eq!(g.num_productions(Symbol::Terminal(0)), 0);
    }

    #[test]
    fn num_productions_for_non_terminal() {
        let g = simple_grammar();
        assert_eq!(g.num_productions(Symbol::NonTerminal(0)), 3);
    }

    #[test]
    fn is_terminal() {
        let g = simple_grammar();
        assert!(g.is_terminal(Symbol::Terminal(0)));
        assert!(!g.is_terminal(Symbol::NonTerminal(0)));
    }

    #[test]
    fn terminal_value() {
        let g = simple_grammar();
        assert_eq!(GrammarDef::terminal_value(&g, Symbol::Terminal(0)), "a");
        assert_eq!(GrammarDef::terminal_value(&g, Symbol::Terminal(1)), "b");
        assert_eq!(GrammarDef::terminal_value(&g, Symbol::Terminal(2)), "c");
    }
}