heuropt 0.11.0

A practical Rust toolkit for heuristic single-, multi-, and many-objective optimization.
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

//! Per-operator property tests covering every Variation / Initializer /
//! Repair impl heuropt ships.

use proptest::prelude::*;

use heuropt::core::rng::rng_from_seed;
use heuropt::prelude::*;

/// Generate per-axis bounds whose width is at least 0.001 (avoid the
/// degenerate `lo == hi` case for properties that need a proper interval).
fn bounds(dim: usize) -> impl Strategy<Value = Vec<(f64, f64)>> {
    prop::collection::vec((-50.0_f64..50.0, 0.001_f64..50.0), dim..=dim).prop_map(|pairs| {
        pairs
            .into_iter()
            .map(|(lo, span)| (lo, lo + span))
            .collect()
    })
}

/// Generate a parent vector inside the given bounds.
fn parent_in_bounds(bounds: &[(f64, f64)]) -> Vec<f64> {
    bounds.iter().map(|&(lo, hi)| 0.5 * (lo + hi)).collect()
}

// -----------------------------------------------------------------------------
// Initializers
// -----------------------------------------------------------------------------

proptest! {
    #[test]
    fn real_bounds_returns_correct_shape(
        bounds in bounds(4),
        size in 1usize..30,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let mut init = RealBounds::new(bounds.clone());
        let decisions = init.initialize(size, &mut rng);
        prop_assert_eq!(decisions.len(), size);
        for d in &decisions {
            prop_assert_eq!(d.len(), 4);
            for (j, &v) in d.iter().enumerate() {
                let (lo, hi) = bounds[j];
                prop_assert!(v >= lo && v <= hi, "{v} out of [{lo}, {hi}]");
            }
        }
    }

    #[test]
    fn real_bounds_size_zero_returns_empty(
        bounds in bounds(3),
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let mut init = RealBounds::new(bounds);
        let decisions = init.initialize(0, &mut rng);
        prop_assert!(decisions.is_empty());
    }
}

// -----------------------------------------------------------------------------
// Real-valued Variation operators
// -----------------------------------------------------------------------------

proptest! {
    #[test]
    fn gaussian_mutation_preserves_length(
        sigma in 1e-6_f64..5.0,
        len in 1usize..10,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let parent: Vec<f64> = vec![0.0; len];
        let mut m = GaussianMutation { sigma };
        let children = m.vary(std::slice::from_ref(&parent), &mut rng);
        prop_assert_eq!(children.len(), 1);
        prop_assert_eq!(children[0].len(), len);
    }

    #[test]
    fn bounded_gaussian_mutation_in_bounds(
        sigma in 1e-6_f64..5.0,
        bounds in bounds(4),
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let parent = parent_in_bounds(&bounds);
        let mut m = BoundedGaussianMutation::new(sigma, bounds.clone());
        let children = m.vary(std::slice::from_ref(&parent), &mut rng);
        prop_assert_eq!(children.len(), 1);
        for (j, &v) in children[0].iter().enumerate() {
            let (lo, hi) = bounds[j];
            prop_assert!(v >= lo && v <= hi);
        }
    }

    #[test]
    fn bit_flip_mutation_preserves_length(
        probability in 0.0_f64..=1.0,
        len in 1usize..32,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let parent: Vec<bool> = (0..len).map(|i| i % 2 == 0).collect();
        let mut m = BitFlipMutation { probability };
        let children = m.vary(std::slice::from_ref(&parent), &mut rng);
        prop_assert_eq!(children.len(), 1);
        prop_assert_eq!(children[0].len(), len);
    }

    #[test]
    fn swap_mutation_is_a_permutation(
        len in 2usize..16,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let parent: Vec<usize> = (0..len).collect();
        let mut m = SwapMutation;
        let children = m.vary(std::slice::from_ref(&parent), &mut rng);
        prop_assert_eq!(children.len(), 1);
        let mut sorted = children[0].clone();
        sorted.sort();
        let identity: Vec<usize> = (0..len).collect();
        prop_assert_eq!(sorted, identity);
    }

    #[test]
    fn sbx_in_bounds(
        bounds in bounds(3),
        eta in 1.0_f64..30.0,
        per_var_p in 0.0_f64..=1.0,
        a_frac in 0.0_f64..1.0,
        b_frac in 0.0_f64..1.0,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let p1: Vec<f64> = bounds.iter().map(|&(lo, hi)| lo + a_frac * (hi - lo)).collect();
        let p2: Vec<f64> = bounds.iter().map(|&(lo, hi)| lo + b_frac * (hi - lo)).collect();
        let mut sbx = SimulatedBinaryCrossover::new(bounds.clone(), eta, per_var_p);
        let children = sbx.vary(&[p1, p2], &mut rng);
        prop_assert_eq!(children.len(), 2);
        for c in &children {
            for (j, &v) in c.iter().enumerate() {
                let (lo, hi) = bounds[j];
                prop_assert!(v >= lo && v <= hi);
            }
        }
    }

    #[test]
    fn polymut_in_bounds(
        bounds in bounds(3),
        eta in 1.0_f64..40.0,
        per_var_p in 0.0_f64..=1.0,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let parent = parent_in_bounds(&bounds);
        let mut pm = PolynomialMutation::new(bounds.clone(), eta, per_var_p);
        let children = pm.vary(std::slice::from_ref(&parent), &mut rng);
        prop_assert_eq!(children.len(), 1);
        for (j, &v) in children[0].iter().enumerate() {
            let (lo, hi) = bounds[j];
            prop_assert!(v >= lo && v <= hi);
        }
    }

    #[test]
    fn levy_mutation_in_bounds(
        bounds in bounds(3),
        alpha in 0.5_f64..2.0,
        scale in 0.01_f64..1.0,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let parent = parent_in_bounds(&bounds);
        let mut m = LevyMutation::new(alpha, scale, bounds.clone());
        let children = m.vary(std::slice::from_ref(&parent), &mut rng);
        prop_assert_eq!(children.len(), 1);
        for (j, &v) in children[0].iter().enumerate() {
            let (lo, hi) = bounds[j];
            prop_assert!(v >= lo && v <= hi);
        }
    }

    #[test]
    fn composite_variation_preserves_count(
        bounds in bounds(3),
        a_frac in 0.0_f64..1.0,
        b_frac in 0.0_f64..1.0,
        seed in any::<u64>(),
    ) {
        let mut rng = rng_from_seed(seed);
        let p1: Vec<f64> = bounds.iter().map(|&(lo, hi)| lo + a_frac * (hi - lo)).collect();
        let p2: Vec<f64> = bounds.iter().map(|&(lo, hi)| lo + b_frac * (hi - lo)).collect();
        // SBX produces 2 children, PolyMut produces 1 each → expect 2.
        let mut v = CompositeVariation {
            crossover: SimulatedBinaryCrossover::new(bounds.clone(), 15.0, 0.5),
            mutation: PolynomialMutation::new(bounds, 20.0, 0.5),
        };
        let children = v.vary(&[p1, p2], &mut rng);
        prop_assert_eq!(children.len(), 2);
    }
}

// -----------------------------------------------------------------------------
// Repair operators
// -----------------------------------------------------------------------------

proptest! {
    #[test]
    fn clamp_to_bounds_lands_in_bounds(
        bounds in bounds(5),
        seed in any::<u64>(),
    ) {
        use rand::Rng as _;
        let mut rng = rng_from_seed(seed);
        let mut x: Vec<f64> = (0..5).map(|_| rng.random_range(-1000.0..=1000.0)).collect();
        let mut r = ClampToBounds::new(bounds.clone());
        r.repair(&mut x);
        for (j, &v) in x.iter().enumerate() {
            let (lo, hi) = bounds[j];
            prop_assert!(v >= lo && v <= hi);
        }
    }

    #[test]
    fn clamp_to_bounds_idempotent(
        bounds in bounds(5),
        seed in any::<u64>(),
    ) {
        use rand::Rng as _;
        let mut rng = rng_from_seed(seed);
        let mut x: Vec<f64> = (0..5).map(|_| rng.random_range(-1000.0..=1000.0)).collect();
        let mut r = ClampToBounds::new(bounds);
        r.repair(&mut x);
        let after_one = x.clone();
        r.repair(&mut x);
        prop_assert_eq!(x, after_one);
    }

    #[test]
    fn project_to_simplex_lands_in_simplex(
        n in 2usize..8,
        total in 0.5_f64..10.0,
        seed in any::<u64>(),
    ) {
        use rand::Rng as _;
        let mut rng = rng_from_seed(seed);
        let mut x: Vec<f64> = (0..n).map(|_| rng.random_range(-5.0..5.0)).collect();
        let mut r = ProjectToSimplex::new(total);
        r.repair(&mut x);
        for &v in &x {
            prop_assert!(v >= 0.0);
        }
        let s: f64 = x.iter().sum();
        prop_assert!((s - total).abs() < 1e-9);
    }

    #[test]
    fn project_to_simplex_idempotent(
        n in 2usize..8,
        total in 0.5_f64..5.0,
        seed in any::<u64>(),
    ) {
        use rand::Rng as _;
        let mut rng = rng_from_seed(seed);
        let mut x: Vec<f64> = (0..n).map(|_| rng.random_range(-5.0..5.0)).collect();
        let mut r = ProjectToSimplex::new(total);
        r.repair(&mut x);
        let after_one = x.clone();
        r.repair(&mut x);
        for (a, b) in after_one.iter().zip(x.iter()) {
            prop_assert!((a - b).abs() < 1e-9);
        }
    }
}