ecrs 0.1.0-beta.4

Evolutionary computation tools & algorithms
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

use crate::aco::pheromone::Pheromone;
use crate::aco::probe::{Probe, ProbingPolicy};
use crate::aco::Solution;

/// ## PolicyDrivenProbe
///
/// Checks whether policy allows for logging and if so, delegates actual logging to wrapped probe
pub struct PolicyDrivenProbe<Ph: Pheromone> {
    probe: Box<dyn Probe<Ph>>,
    policy: Box<dyn ProbingPolicy>,
}

impl<Ph: Pheromone> PolicyDrivenProbe<Ph> {
    /// Returns new instance of [PolicyDrivenProbe]
    ///
    /// ### Arguments
    ///
    /// * `policy` - logging policy to apply
    /// * `probe` - probe used to logging
    pub fn new(probe: Box<dyn Probe<Ph>>, policy: Box<dyn ProbingPolicy>) -> PolicyDrivenProbe<Ph> {
        PolicyDrivenProbe { probe, policy }
    }
}

impl<Ph: Pheromone> Probe<Ph> for PolicyDrivenProbe<Ph> {
    /// This method is called to report on pheromone update.
    ///
    /// Delegates actual logging to wrapped `probe` only if `policy` returns `true`
    ///
    /// ### Arguments
    ///
    /// * `old_pheromone` - Matrix containing pheromone values before update
    /// * `new_pheromone` - Matrix containing pheromone values after update
    fn on_pheromone_update(&mut self, old_pheromone: &Ph, new_pheromone: &Ph) {
        if self.policy.on_pheromone_update() {
            self.probe.on_pheromone_update(old_pheromone, new_pheromone);
        }
    }

    /// This method is called to report on the best solution in current iteration.
    ///
    /// Delegates actual logging to wrapped `probe` only if `policy` returns `true`
    ///
    /// ### Arguments
    ///
    /// * `best` - current best solution
    fn on_current_best(&mut self, best: &Solution) {
        if self.policy.on_current_best() {
            self.probe.on_current_best(best);
        }
    }

    /// This method is called in the very begining of algorithm's main loop.
    ///
    /// Delegates actual logging to wrapped `probe` only if `policy` returns `true`
    ///
    /// ### Arguments
    ///
    /// * `iteration` - current iteration number
    fn on_iteration_start(&mut self) {
        if self.policy.on_iteration_start() {
            self.probe.on_iteration_start();
        }
    }

    /// This method is called in the very end of algorithm's main loop, just before
    /// termination conditions are evaluated.
    ///
    /// Delegates actual logging to wrapped `probe` only if `policy` returns `true`
    ///
    /// ### Arguments
    ///
    /// * `iteration` - current iteration number
    fn on_iteration_end(&mut self) {
        if self.policy.on_iteration_end() {
            self.probe.on_iteration_end();
        }
    }

    /// This method is called after algorithm 's main loop is exited, just before the `run`
    /// method returns
    ///
    /// Delegates actual logging to wrapped `probe` only if `policy` returns `true`
    fn on_end(&mut self) {
        if self.policy.on_end() {
            self.probe.on_end();
        }
    }
}