optimum 0.0.4

Future Framework to solve optimization problems
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

use std::marker::PhantomData;

use crate::core::Problem;

use super::StopCriterion;

/// The execution stops after N iterations.
#[derive(Debug)]
pub struct IterCriterion<P> {
    current_iter: usize,
    max_iter: usize,
    _p: PhantomData<P>,
}

impl<P> Clone for IterCriterion<P> {
    fn clone(&self) -> Self {
        Self {
            current_iter: self.current_iter,
            max_iter: self.max_iter,
            _p: self._p,
        }
    }
}

impl<P: Problem> IterCriterion<P> {
    /// Creates a new iteration criterion.
    ///
    /// Stops as soon as `max_iter` iterations are performed.
    pub fn new(max_iter: usize) -> Self {
        Self {
            max_iter,
            current_iter: 0,
            _p: PhantomData,
        }
    }
}

impl<P: Problem> StopCriterion<P> for IterCriterion<P> {
    fn progress(&self) -> f64 {
        self.current_iter as f64 / self.max_iter as f64
    }

    fn update(&mut self, _: P::Value) {
        self.current_iter += 1;
    }

    fn current_iter(&self) -> usize {
        self.current_iter
    }
}

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

    #[test]
    fn it_works() {
        let mut stop = IterCriterion::<()>::new(10);
        for _ in 0..10 {
            assert!(!stop.should_stop());
            stop.update(0);
        }
        assert!(stop.should_stop());
        assert_eq!(stop.current_iter(), 10);
    }
}