roma_lib 0.1.1

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

use crate::solution::{finalize_scalar_solution, Solution};

/// Builder for string-based solutions (`Solution<String>`).
pub struct StringSolutionBuilder {
    variables: Vec<String>,
    quality: Option<f64>,
}

impl StringSolutionBuilder {
    /// Creates a builder with `size` empty strings.
    pub fn new(size: usize) -> Self {
        Self {
            variables: vec!["".to_string(); size],
            quality: None,
        }
    }

    /// Creates a builder from an existing variable vector.
    pub fn from_variables(variables: Vec<String>) -> Self {
        Self {
            variables,
            quality: None,
        }
    }

    /// Replaces the current variable vector.
    pub fn with_variables(mut self, variables: Vec<String>) -> Self {
        self.variables = variables;
        self
    }

    /// Sets an optional initial scalar quality value.
    pub fn with_quality(mut self, quality: f64) -> Self {
        self.quality = Some(quality);
        self
    }

    /// Sets one variable if `index` is within bounds.
    pub fn set_variable(mut self, index: usize, value: String) -> Self {
        if index < self.variables.len() {
            self.variables[index] = value;
        }
        self
    }

    /// Fills all variables with the same string value.
    pub fn fill(mut self, value: String) -> Self {
        self.variables.fill(value);
        self
    }

    /// Builds the final string solution.
    pub fn build(self) -> Solution<String> {
        finalize_scalar_solution(self.variables, self.quality)
    }
}

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

    #[test]
    fn builder_creates_expected_size() {
        let s = StringSolutionBuilder::new(3).build();
        assert_eq!(s.num_variables(), 3);
        assert_eq!(s.variables(), &["", "", ""]);
    }

    #[test]
    fn fill_and_set_variable_work() {
        let s = StringSolutionBuilder::new(3)
            .fill("x".to_string())
            .set_variable(1, "y".to_string())
            .build();

        assert_eq!(s.variables(), &["x", "y", "x"]);
    }

    #[test]
    fn with_quality_sets_scalar_quality() {
        let s = StringSolutionBuilder::new(2).with_quality(3.5).build();
        assert_eq!(s.quality().copied(), Some(3.5));
    }
}