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
use crate::aco::colony::Colony;
use crate::aco::fitness::{CanonicalFitness, Fitness};
use crate::aco::pheromone::{Pheromone, PheromoneUpdate};
use crate::aco::probe::{Probe, StdoutProbe};
use crate::aco::termination_condition::{IterationCond, TerminationCondition};
use crate::aco::{AntColonyOptimization, FMatrix};
/// Builder for [AntColonyOptimization]
///
pub struct Builder<P, C, F, T, Pr, Ph>
where
P: PheromoneUpdate<Ph>,
C: Colony<Ph>,
F: Fitness,
T: TerminationCondition<Ph>,
Pr: Probe<Ph>,
Ph: Pheromone,
{
evaporation_rate: f64,
solution_size: usize,
pheromone_update: Option<P>,
fitness: Option<F>,
colony: Option<C>,
termination_cond: Option<T>,
start_pheromone: Option<Ph>,
probe: Option<Pr>,
}
impl<P, C, F, T, Pr, Ph> Builder<P, C, F, T, Pr, Ph>
where
P: PheromoneUpdate<Ph>,
C: Colony<Ph>,
F: Fitness,
T: TerminationCondition<Ph>,
Pr: Probe<Ph>,
Ph: Pheromone,
{
/// Creates a new instance of Builder.
///
/// ### Defaults
/// * `evaporation_rate` - 0.1
/// * `start_pheromone` - matrix of 1.0
pub fn new(solution_size: usize) -> Self {
Builder {
evaporation_rate: 0.1,
solution_size,
pheromone_update: None,
fitness: None,
colony: None,
termination_cond: None,
start_pheromone: None,
probe: None,
}
}
/// Sets the used [Probe].
///
///
/// ## Arguments
/// * `probe` - [Probe] trait implementation.
pub fn set_probe(mut self, probe: Pr) -> Self {
self.probe = Some(probe);
self
}
/// Sets the the way to calculate pheromone update.
///
/// For more info see [aco::pheromone] module.
///
/// ## Arguments
/// * `pheromone_update` - Implementation of [PheromoneUpdate] trait.
pub fn set_pheromone_update(mut self, pheromone_update: P) -> Self {
self.pheromone_update = Some(pheromone_update);
self
}
/// Sets the the way to calculate fitness.
///
/// For more info see [aco::fitness] module.
///
/// ## Arguments
/// * `fitness` - Implementation of [Fitness] trait.
pub fn set_fitness(mut self, fitness: F) -> Self {
self.fitness = Some(fitness);
self
}
/// Sets the termination condition.
///
/// For more info see [aco::termination_condition] module.
///
/// ## Arguments
/// * `termination_condition` - Implementation of [TerminationCondition] trait.
pub fn set_termination_condition(mut self, termination_condition: T) -> Self {
self.termination_cond = Some(termination_condition);
self
}
/// Sets the initial pheromone.
/// ## Arguments
/// * `start_pheromone` - Initial pheromone.
pub fn set_start_pheromone(mut self, start_pheromone: Ph) -> Self {
self.start_pheromone = Some(start_pheromone);
self
}
/// Sets ants colony.
/// ## Arguments
/// * `colony` - ants colony.
pub fn set_colony(mut self, colony: C) -> Self {
self.colony = Some(colony);
self
}
/// Builds [AntColonyOptimization] with provided building blocks.
///
/// * `pheromone_update` needs to be specified, if not program will panic
/// * `start_pheromone` needs to be specified, if not program will panic
/// * `ants_behaviour` needs to be specified, if not program will panic
/// * `fitness` needs to be specified, if not program will panic
/// * `goodness` needs to be specified, if not program will panic
/// * `ants` need to be specified, if not program will panic
pub fn build(self) -> AntColonyOptimization<P, C, F, T, Pr, Ph> {
AntColonyOptimization {
evaporation_rate: self.evaporation_rate,
colony: self.colony.expect("Colony wasn't set"),
pheromone: self.start_pheromone.expect("Start pheromone wasn't set"),
pheromone_update: self.pheromone_update.expect("Pheromone update rule wasn't set"),
fitness: self.fitness.expect("Fitness operator wasn't set"),
termination_cond: self.termination_cond.expect("Termination condition wasn't set"),
probe: self.probe.expect("Probe wasn't set"),
}
}
}
impl<P, C, T, Pr, Ph> Builder<P, C, CanonicalFitness, T, Pr, Ph>
where
P: PheromoneUpdate<Ph>,
C: Colony<Ph>,
T: TerminationCondition<Ph>,
Pr: Probe<Ph>,
Ph: Pheromone,
{
/// Sets the weighted graph to be searched.
///
/// ## Arguments
/// * `weights` - Weighted graph in matrix representation.
pub fn set_weights(mut self, weights: FMatrix) -> Self {
assert_eq!(
weights.nrows(),
weights.nrows(),
"Weights should be a square matrix"
);
assert_eq!(
weights.nrows(),
self.solution_size,
"Weights should be of length equal to solution size"
);
if let Some(mut f) = self.fitness {
f.weights = weights;
self.fitness = Some(f)
} else {
self.fitness = Some(CanonicalFitness::new(weights))
}
self
}
}
impl<P, C, F, Pr, Ph> Builder<P, C, F, IterationCond, Pr, Ph>
where
P: PheromoneUpdate<Ph>,
C: Colony<Ph>,
F: Fitness,
Pr: Probe<Ph>,
Ph: Pheromone,
{
/// Sets iteration termination condition.
///
/// ## Arguments
/// * `iterations_limit` - maximal number of iterations.
pub fn with_iteration_termination(mut self, iterations_limit: usize) -> Self {
self.termination_cond = Some(IterationCond::new(iterations_limit));
self
}
}
impl<P, C, F, T> Builder<P, C, F, T, StdoutProbe, FMatrix>
where
P: PheromoneUpdate<FMatrix>,
C: Colony<FMatrix>,
F: Fitness,
T: TerminationCondition<FMatrix>,
{
/// Sets probe to [StdoutProbe].
pub fn with_stdout_probe(mut self) -> Self {
self.probe = Some(StdoutProbe::new());
self
}
}