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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
extern crate rand;
#[macro_use]
extern crate serde_derive;
extern crate serde;

use rand::{thread_rng, ThreadRng, SeedableRng, Rng, StdRng};
use rand::distributions::Uniform;
use rand::distributions::StandardNormal;
use rand::distributions::{Distribution};

#[macro_use]
#[cfg(test)]
extern crate approx;
#[cfg(test)]
use std::f64::consts::PI;

#[derive(Serialize, Deserialize, Clone)]
pub struct UpperLower {
    pub lower: f64,
    pub upper: f64,
}

fn get_levy(alpha:f64, uniform_rand:f64)->f64 {
    uniform_rand.powf(-1.0/alpha)
}

fn get_levy_flight(
    curr_val:f64,
    step_size:f64,
    lambda:f64,
    uniform_rand:f64,
    norm_rand:f64
)->f64 {
    curr_val+step_size*get_levy(lambda, uniform_rand)*norm_rand
}

fn get_truncated_parameter(
    lower:f64,
    upper:f64,
    result:f64
)->f64 {
    if result>upper {upper} else if result<lower {lower} else {result}
}

fn get_random_parameter(
    lower:f64,
    upper:f64,
    rand:f64
)->f64{
    let half=0.5;
    get_truncated_parameter(lower, upper, (upper+lower)*half+(upper-lower)*half*rand) //reflects middle more likely than edges
}



fn get_random_parameters<T, U>(
    ul:&[UpperLower],
    rng:&mut T,
    rand:&mut U
)->Vec<f64>
    where 
        T:Rng,
        U:Distribution<f64>
{
    ul.iter().map(|v|get_random_parameter(v.lower, v.upper, rand.sample(rng))).collect()
}

fn get_new_parameter_and_fn<T, U, S>(
    ul:&[UpperLower],
    obj_fn:S,
    rng:&mut T,
    rand:&mut U
)->(Vec<f64>, f64) 
    where 
        S:Fn(&[f64])->f64,
        T:Rng,
        U:Distribution<f64>
{
    let parameters=get_random_parameters(ul, rng, rand);
    let fn_value_at_parameters=obj_fn(&parameters);
    (parameters, fn_value_at_parameters)
}

const STEP_INCREMENT:f64=0.01;
fn get_step_size(curr:f64, best:f64, lower:f64, upper:f64)->f64{
    STEP_INCREMENT*(upper-lower)*(curr-best)
}

fn get_new_nest<T, U, S>(
    ul:&[UpperLower], 
    obj_fn:S,
    n:usize,
    rng:&mut T,
    rand:&mut U
)->Vec<(Vec<f64>, f64)>
    where 
        S: Fn(&[f64])->f64,
        T:Rng,
        U:Distribution<f64>
{
    (0..n).map(|_|get_new_parameter_and_fn(ul, &obj_fn, rng, rand)).collect()
}

fn sort_nest(
    nest:&mut Vec<(Vec<f64>, f64)>//move nest
){
    nest.sort_by(|(_, a), (_, b)| a.partial_cmp(b).unwrap());//smallest to largest
}

fn get_best_nest(
    new_nest:&[(Vec<f64>, f64)],
    curr_nest:&mut Vec<(Vec<f64>, f64)>//move curr_nest
){
    curr_nest.iter_mut().zip(new_nest.iter()).for_each(|(curr_val, new_val)|{
        let (curr_params, curr_fn_val)=curr_val;
        let (new_params, new_fn_val)=new_val;
        if new_fn_val< curr_fn_val { 
            *curr_params=new_params.to_vec();
            *curr_fn_val=*new_fn_val;
        } 
    });
    sort_nest(curr_nest);
}

fn get_cuckoos<T, G, U>(
    new_nest:&mut Vec<(Vec<f64>, f64)>, 
    curr_nest:&[(Vec<f64>, f64)],
    best_parameters:&[f64],
    ul:&[UpperLower],
    obj_fn:impl Fn(&[f64])->f64,
    lambda:f64,
    rng:&mut T,
    uniform:&mut U,
    normal:&mut G
)
    where
        T:Rng,
        G:Distribution<f64>,
        U:Distribution<f64>
{
    new_nest.iter_mut()
        .zip(curr_nest.iter())
        .for_each(|(new_val, curr_val)|{
            let (new_parameters, new_fn_val)=new_val;
            let (curr_parameters,_)=curr_val;
            *new_parameters=curr_parameters.iter()
                .zip(ul.iter())
                .zip(best_parameters.iter())
                .map(|((curr_param, v), bp)|{
                    get_truncated_parameter(
                        v.lower, v.upper, 
                        get_levy_flight(
                            *curr_param, 
                            get_step_size(*curr_param, *bp, v.lower, v.upper), 
                            lambda, 
                            uniform.sample(rng), 
                            normal.sample(rng)
                        )
                    )
                }).collect();
            
            *new_fn_val=obj_fn(&new_parameters);
        });
}

fn get_pa(
    p_min:f64,
    p_max:f64,
    index:usize,
    n:usize
)->f64{
    p_max-(p_max-p_min)*(index as f64)/(n as f64)
}

fn empty_nests<T, U>(
    new_nest:&mut Vec<(Vec<f64>, f64)>, //
    obj_fn:&impl Fn(&[f64])->f64,
    ul:&[UpperLower],
    p:f64,
    rng:&mut T,
    rand:&mut U
)
    where 
        T:Rng,
        U:Distribution<f64>
{
    let n=new_nest.len();
    let num_to_keep=((n as f64)*p) as usize;
    let start_num=n-num_to_keep;
    new_nest.iter_mut().enumerate().filter(|(index, _)|index>=&start_num).for_each(|(_, new_val)|{
        *new_val=get_new_parameter_and_fn(ul, &obj_fn, rng, rand);
    });
}

pub fn get_rng_seed(seed:[u8; 32])->StdRng{
    SeedableRng::from_seed(seed) 
}

pub fn get_rng_system_seed()->ThreadRng{
    thread_rng()
}

pub fn optimize<T>(
    obj_fn:&impl Fn(&[f64])->f64,
    ul:&[UpperLower],
    n:usize,
    total_mc:usize,
    tol:f64,
    rng_inst:impl Fn()->T
)->(Vec<f64>, f64)
    where T:Rng
{
    
    let lambda=1.5;//controls size of levy moves
    let p_min=0.05;//min percentage of nests to replace
    let p_max=0.5;//max percentage of nests to replace

    //randomness
    let mut rng=rng_inst();
    let mut normal=StandardNormal;
    let mut uniform=Uniform::new(0.0f64, 1.0);

    //starting nests
    let mut curr_nest=get_new_nest(&ul, &obj_fn, n, &mut rng, &mut normal);
    sort_nest(&mut curr_nest);
    let mut new_nest=get_new_nest(&ul, &obj_fn, n, &mut rng, &mut normal);

    let mut index=0;
    loop {
        get_cuckoos(
            &mut new_nest, &curr_nest, 
            &curr_nest.first().unwrap().0, //currently best parameters 
            &ul, 
            &obj_fn, lambda, 
            &mut rng, &mut uniform, &mut normal
        );
        get_best_nest(&new_nest, &mut curr_nest);
        empty_nests(
            &mut curr_nest, 
            &obj_fn, &ul,
            get_pa(p_min, p_max, index, total_mc),
            &mut rng,
            &mut normal
        );
        sort_nest(&mut curr_nest);
        index=index+1;
        
        if cfg!(feature="VERBOSE_FLAG") {
            print!("Index: {}, Param Vals: ", index);
            for val in curr_nest[0].0.iter(){
                print!("{}", val);
            }
            println!("Objective Value: {}", curr_nest[0].1);
        }
        if index>=total_mc || curr_nest.first().unwrap().1<=tol {break;}
    }
    let (optim_parameters, optim_fn_val)=curr_nest.first().unwrap();
    (optim_parameters.to_vec(), *optim_fn_val)
}


#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn sort_algorithm(){
        let mut vec_to_sort:Vec<(Vec<f64>, f64)>=vec![];
        vec_to_sort.push((vec![1.0], 3.0));
        vec_to_sort.push((vec![1.0], 2.0));
        vec_to_sort.push((vec![1.0], 5.0));
        sort_nest(&mut vec_to_sort);
        let expected:Vec<f64>=vec![2.0, 3.0, 5.0];
        for (val, expected) in vec_to_sort.iter().zip(expected.iter()){
            let (_, v)=*val;
            assert_eq!(v, *expected);
        }
    }
    #[test]
    fn simple_fn_optim() {
        let seed:[u8; 32]=[0; 32];
        let mut ul=vec![];
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        let (result, fn_val)=optimize(&|inputs:&[f64]|{
            inputs[0].powi(2)+inputs[1].powi(2)+inputs[2].powi(2)+inputs[3].powi(2)
        }, &ul, 25, 1000, 0.00000001, || get_rng_seed(seed));
        for res in result.iter(){
            assert_abs_diff_eq!(*res, 0.0, epsilon=0.001);
        }
        assert_abs_diff_eq!(fn_val, 0.0, epsilon=0.00001);
    }
    #[test]
    fn test_rosenbrok_function(){
        let seed:[u8; 32]=[0; 32];
        let mut ul=vec![];
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        let (result, fn_val)=optimize(&|inputs:&[f64]|{
            (1.0-inputs[0]).powi(2)+100.0*(inputs[1]-inputs[0].powi(2)).powi(2)
        }, &ul, 20, 10000, 0.00000001, || get_rng_seed(seed));
        for res in result.iter(){
            assert_abs_diff_eq!(*res, 1.0, epsilon=0.001);
        }
        assert_abs_diff_eq!(fn_val, 0.0, epsilon=0.00001);
    }
    #[test]
    fn test_u_2_function(){ //16 parameters
        let seed:[u8; 32]=[0; 32];
        let mut ul=vec![];
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        ul.push(UpperLower{ lower:-5.0, upper:5.0});
        let (result, fn_val)=optimize(&|inputs:&[f64]|{
            inputs.iter().fold(0.0, |accum, curr|accum+(curr-1.0).powi(2))
        }, &ul, 25, 25000, 0.00000001, || get_rng_seed(seed));
        for res in result.iter(){
            assert_abs_diff_eq!(*res, 1.0, epsilon=0.001);
        }
        assert_abs_diff_eq!(fn_val, 0.0, epsilon=0.00001);
    }
    #[test]
    fn test_rastigrin_function(){
        let seed:[u8; 32]=[0; 32];
        let mut ul=vec![];
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        ul.push(UpperLower{ lower:-4.0, upper:4.0});
        let rastigrin_scale=10.0;
        let (result, fn_val)=optimize(&|inputs:&[f64]|{
            rastigrin_scale*(inputs.len() as f64)+inputs.iter().fold(
                0.0, |accum, curr|accum+curr.powi(2)-rastigrin_scale*(2.0*PI*curr).cos()
            )
        }, &ul, 25, 25000, 0.00000001, || get_rng_seed(seed));
        for res in result.iter(){
            assert_abs_diff_eq!(*res, 0.0, epsilon=0.001);
        }
        assert_abs_diff_eq!(fn_val, 0.0, epsilon=0.00001);
    }


}