genevo 0.7.1

genevo provides building blocks to run simulations of optimization and search problems using genetic algorithms (GA). Execute genetic algorithm (GA) simulations in a customizable and extensible way.
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

use crate::{
    algorithm::Algorithm,
    simulation::State,
    termination::{StopFlag, Termination},
};
use std::marker::PhantomData;

// TODO add doc comments
pub fn and<T1, T2, A>(condition1: T1, condition2: T2) -> And<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    And::new(condition1, condition2)
}

// TODO add doc comments
#[derive(Clone, Debug, PartialEq)]
pub struct And<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    condition1: T1,
    condition2: T2,
    _a: PhantomData<A>,
}

impl<T1, T2, A> And<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    pub fn new(condition1: T1, condition2: T2) -> Self {
        And {
            condition1,
            condition2,
            _a: PhantomData,
        }
    }

    pub fn condition1(&self) -> &T1 {
        &self.condition1
    }

    pub fn condition2(&self) -> &T2 {
        &self.condition2
    }
}

impl<T1, T2, A> Termination<A> for And<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    fn evaluate(&mut self, state: &State<A>) -> StopFlag {
        let mut reasons = Vec::with_capacity(2);
        match self.condition1.evaluate(state) {
            StopFlag::StopNow(reason) => reasons.push(reason),
            StopFlag::Continue => (),
        }
        match self.condition2.evaluate(state) {
            StopFlag::StopNow(reason) => reasons.push(reason),
            StopFlag::Continue => (),
        }
        match reasons.len() {
            0 | 1 => StopFlag::Continue,
            _ => StopFlag::StopNow(reasons.join(" and ")), /* TODO how combine the two `StopReason`s preserving combinator semantics? */
        }
    }
}

// TODO add doc comments
pub fn or<T1, T2, A>(condition1: T1, condition2: T2) -> Or<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    Or::new(condition1, condition2)
}

// TODO add doc comments
#[derive(Clone, Debug, PartialEq)]
pub struct Or<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    condition1: T1,
    condition2: T2,
    _a: PhantomData<A>,
}

impl<T1, T2, A> Or<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    pub fn new(condition1: T1, condition2: T2) -> Self {
        Or {
            condition1,
            condition2,
            _a: PhantomData,
        }
    }

    pub fn condition1(&self) -> &T1 {
        &self.condition1
    }

    pub fn condition2(&self) -> &T2 {
        &self.condition2
    }
}

impl<T1, T2, A> Termination<A> for Or<T1, T2, A>
where
    T1: Termination<A>,
    T2: Termination<A>,
    A: Algorithm,
{
    fn evaluate(&mut self, state: &State<A>) -> StopFlag {
        let mut reasons = Vec::with_capacity(2);
        match self.condition1.evaluate(state) {
            StopFlag::StopNow(reason) => reasons.push(reason),
            StopFlag::Continue => (),
        }
        match self.condition2.evaluate(state) {
            StopFlag::StopNow(reason) => reasons.push(reason),
            StopFlag::Continue => (),
        }
        match reasons.len() {
            0 => StopFlag::Continue,
            1 => StopFlag::StopNow(reasons[0].clone()),
            _ => StopFlag::StopNow(reasons.join(" and ")), /* TODO how combine the two `StopReason`s preserving combinator semantics? */
        }
    }
}