roma_lib 0.1.0

A Rust metaheuristics framework inspired by jMetal for optimization and experimentation.
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

use std::fmt::Display;

use crate::solution::traits::Dominance;
use crate::solution::Solution;
use crate::solution_set::traits::SolutionSet;

#[derive(Clone)]
pub struct VectorSolutionSet<T, Q = f64>
where
    T: Clone,
    Q: Clone,
{
    solutions: Vec<Solution<T, Q>>,
}

impl<T, Q> VectorSolutionSet<T, Q>
where
    T: Clone,
    Q: Clone,
{
    pub fn new() -> Self {
        Self {
            solutions: Vec::new(),
        }
    }

    pub fn from_vec(solutions: Vec<Solution<T, Q>>) -> Self {
        Self { solutions }
    }
}

impl<T, Q> SolutionSet<T, Q> for VectorSolutionSet<T, Q>
where
    T: Clone + Display,
    Q: Clone + Dominance + Display,
{
    fn iter(&self) -> Box<dyn Iterator<Item = &Solution<T, Q>> + '_> {
        Box::new(self.solutions.iter())
    }

    fn push_solution(&mut self, solution: Solution<T, Q>) {
        self.solutions.push(solution);
    }

    fn pop_solution(&mut self) -> Option<Solution<T, Q>> {
        self.solutions.pop()
    }

    fn clear_solutions(&mut self) {
        self.solutions.clear();
    }

    fn get_solution(&self, index: usize) -> Option<&Solution<T, Q>> {
        self.solutions.get(index)
    }

    fn get_solution_mut(&mut self, index: usize) -> Option<&mut Solution<T, Q>> {
        self.solutions.get_mut(index)
    }

    fn len(&self) -> usize {
        self.solutions.len()
    }
}

#[cfg(test)]
mod test {
    use crate::solution::implementations::real_solution::RealSolutionBuilder;
    use crate::solution::implementations::string_solution::StringSolutionBuilder;
    use crate::solution_set::implementations::vector_solution_set::VectorSolutionSet;
    use crate::solution_set::traits::SolutionSet;

    #[test]
    fn get_best_solution_test() {
        let mut solution_set: VectorSolutionSet<f64> = VectorSolutionSet::new();

        let best_solution = RealSolutionBuilder::new(3).with_quality(10.0).build();

        let worst_solution = RealSolutionBuilder::new(3).with_quality(0.0).build();

        solution_set.add_solution(worst_solution);
        solution_set.add_solution(best_solution);

        let best = solution_set.best_solution().unwrap();
        assert_eq!(best.quality().copied(), Some(10.0));
    }

    #[test]
    fn vector_solution_creates_empty_test() {
        let solution_set: VectorSolutionSet<String> = VectorSolutionSet::new();

        assert!(solution_set.is_empty());
    }

    #[test]
    fn number_of_solutions_test() {
        let mut solution_set: VectorSolutionSet<String> = VectorSolutionSet::new();

        let variables = vec![
            "jMetal".to_string(),
            "jMetalPy".to_string(),
            "MEALPY".to_string(),
        ];
        let solution = StringSolutionBuilder::from_variables(variables)
            .with_quality(10.0)
            .build();

        solution_set.add_solution(solution);

        assert!(!solution_set.is_empty());
        assert_eq!(solution_set.size(), 1);
        assert_eq!(solution_set.best_solution().unwrap().quality(), Some(&10.0));
    }

    #[test]
    fn best_solution_value_or_uses_default_for_empty_set() {
        let solution_set: VectorSolutionSet<f64> = VectorSolutionSet::new();
        assert_eq!(solution_set.best_solution_value_or(-1.0), -1.0);
    }

    #[test]
    fn remove_solution_returns_last_inserted_solution() {
        let mut solution_set: VectorSolutionSet<f64> = VectorSolutionSet::new();
        solution_set.add_solution(RealSolutionBuilder::new(2).with_quality(1.0).build());
        solution_set.add_solution(RealSolutionBuilder::new(2).with_quality(3.0).build());

        let removed = solution_set
            .remove_solution()
            .expect("Expected one removed solution");
        assert_eq!(removed.quality().copied(), Some(3.0));
        assert_eq!(solution_set.size(), 1);
    }
}