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
|
# -*- coding: utf-8 -*-
"""
This module contains a parent class to MOArchiving3obj and MOArchiving4obj,
to avoid code duplication.
"""
from moarchiving.moarchiving_utils import setup_cdllist, weakly_dominates
inf = float('inf')
class MOArchiveParent:
"""Parent class for Moarchiving 3 and 4 objective classes, to avoid code duplication """
def __init__(self, list_of_f_vals=None, reference_point=None, infos=None, n_obj=None,
hypervolume_final_float_type=None,
hypervolume_computation_float_type=None):
"""Create a new archive object. """
self.hypervolume_final_float_type = hypervolume_final_float_type
self.hypervolume_computation_float_type = hypervolume_computation_float_type
if list_of_f_vals is not None and len(list_of_f_vals):
try:
list_of_f_vals = list_of_f_vals.tolist()
except:
pass
list_of_f_vals = [list(f_vals) for f_vals in list_of_f_vals]
if len(list_of_f_vals[0]) != n_obj:
raise ValueError(f"need elements of length {n_obj}, got {list_of_f_vals[0]}"
" as first element")
else:
list_of_f_vals = []
self.n_obj = n_obj
self._length = 0
if infos is None:
infos = [None] * len(list_of_f_vals)
if reference_point is not None:
self.reference_point = list(reference_point)
self.head = setup_cdllist(self.n_obj, list_of_f_vals, self.reference_point, infos)
else:
self.reference_point = None
self.head = setup_cdllist(self.n_obj, list_of_f_vals, [inf] * self.n_obj, infos)
self._kink_points = None
def __len__(self):
return self._length
def __iter__(self):
pg = self._points_generator()
el = next(pg, None)
while el is not None:
yield el.x[:self.n_obj]
el = next(pg, None)
def add(self, new, info=None, update_hypervolume=True):
raise NotImplementedError("This method should be implemented in the child class")
def remove(self, f_vals):
raise NotImplementedError("This method should be implemented in the child class")
def add_list(self, list_of_f_vals, infos=None):
raise NotImplementedError("This method should be implemented in the child class")
def copy(self):
raise NotImplementedError("This method should be implemented in the child class")
def dominates(self, f_val):
"""return `True` if any element of `points` dominates or is equal to `f_val`.
Otherwise return `False`.
>>> from moarchiving.get_archive import get_mo_archive
>>> archive = get_mo_archive([[1, 2, 3], [3, 2, 1]])
>>> archive.dominates([2, 2, 2])
False
>>> archive.dominates([1, 2, 3])
True
>>> archive.dominates([3, 3, 3])
True
"""
for point in self._points_generator():
if weakly_dominates(point.x, f_val, self.n_obj):
return True
# points are sorted in lexicographic order, so we can return False
# once we find a point that is lexicographically greater than f_val
elif f_val[self.n_obj - 1] < point.x[self.n_obj - 1]:
return False
return False
def dominators(self, f_val, number_only=False):
"""return the list of all `f_val`-dominating elements in `self`,
including an equal element. ``len(....dominators(...))`` is
hence the number of dominating elements which can also be obtained
without creating the list with ``number_only=True``.
>>> from moarchiving.get_archive import get_mo_archive
>>> archive = get_mo_archive([[1, 2, 3], [3, 2, 1], [2, 2, 2], [3, 0, 3]])
>>> archive.dominators([1, 1, 1])
[]
>>> archive.dominators([3, 3, 3])
[[3, 2, 1], [2, 2, 2], [3, 0, 3], [1, 2, 3]]
>>> archive.dominators([2, 3, 4])
[[2, 2, 2], [1, 2, 3]]
>>> archive.dominators([3, 3, 3], number_only=True)
4
"""
dominators = [] if not number_only else 0
for point in self._points_generator():
if all(point.x[i] <= f_val[i] for i in range(self.n_obj)):
if number_only:
dominators += 1
else:
dominators.append(point.x[:self.n_obj])
# points are sorted in lexicographic order, so we can break the loop
# once we find a point that is lexicographically greater than f_val
elif f_val[self.n_obj - 1] < point.x[self.n_obj - 1]:
break
return dominators
def in_domain(self, f_vals, reference_point=None):
"""return `True` if `f_vals` is dominating the reference point,
`False` otherwise. `True` means that `f_vals` contributes to
the hypervolume if not dominated by other elements.
>>> from moarchiving.get_archive import get_mo_archive
>>> archive3obj = get_mo_archive(reference_point=[3, 3, 3])
>>> archive3obj.in_domain([2, 2, 2])
True
>>> archive3obj.in_domain([0, 0, 3])
False
>>> archive4obj = get_mo_archive(reference_point=[3, 3, 3, 3])
>>> archive4obj.in_domain([2, 2, 2, 2])
True
>>> archive4obj.in_domain([0, 0, 0, 3])
False
"""
try:
if len(f_vals) != self.n_obj:
raise ValueError(f"argument `f_vals` must be of length {self.n_obj}, "
f"was ``{f_vals}``")
except TypeError:
raise TypeError(f"argument `f_vals` must be a list, was ``{f_vals}``")
if reference_point is None:
reference_point = self.reference_point
if reference_point is None:
return True
if any(f_vals[i] >= reference_point[i] for i in range(self.n_obj)):
return False
return True
def _points_generator(self, include_head=False):
"""returns the points in the archive in a form of a python generator
instead of a circular doubly linked list """
first_iter = True
di = self.n_obj - 1
if include_head:
curr = self.head
stop = self.head
else:
curr = self.head.next[di].next[di]
stop = self.head.prev[di]
if curr == stop:
return
while curr != stop or first_iter:
yield curr
first_iter = False
curr = curr.next[di]
@property
def infos(self):
"""`list` of complementary information corresponding to each archive entry,
corresponding to each of the points in the archive
>>> from moarchiving.get_archive import get_mo_archive
>>> moa = get_mo_archive([[1, 2, 3], [3, 2, 1], [2, 2, 2]], infos=["a", "b", "c"])
>>> moa.infos
['b', 'c', 'a']
"""
return [point.info for point in self._points_generator()]
@property
def hypervolume(self):
"""Return the hypervolume of the archive """
if self.reference_point is None:
raise ValueError("to compute the hypervolume indicator a reference"
" point is needed (must be given initially)")
return self._hypervolume
@property
def hypervolume_plus(self):
"""Return the hypervolume_plus of the archive """
if self.reference_point is None:
raise ValueError("to compute the hypervolume_plus indicator a reference"
" point is needed (must be given initially)")
return self._hypervolume_plus
@property
def contributing_hypervolumes(self):
"""`list` of hypervolume contributions of each point in the archive"""
return [self.contributing_hypervolume(point[:self.n_obj]) for point in self]
def contributing_hypervolume(self, f_vals):
"""Return the hypervolume contribution of a point in the archive
>>> from moarchiving.get_archive import get_mo_archive
>>> get_mo_archive.hypervolume_final_float_type = float
>>> moa = get_mo_archive([[1, 2, 3], [3, 2, 1], [2, 3, 2]], reference_point=[4, 4, 4])
>>> moa.contributing_hypervolume([1, 2, 3])
3.0
>>> moa.contributing_hypervolume([3, 2, 1])
3.0
>>> moa.contributing_hypervolume([2, 3, 2])
1.0
"""
try:
if len(f_vals) != self.n_obj:
raise ValueError(f"argument `f_vals` must be of length {self.n_obj}, "
f"was ``{f_vals}``")
except TypeError:
raise TypeError(f"argument `f_vals` must be a list, was ``{f_vals}``")
if f_vals in self:
hv_before = self._hypervolume
removed_info = self.remove(f_vals)
hv_after = self._hypervolume
self.add(f_vals, info=removed_info)
return hv_before - hv_after
else:
return self.hypervolume_improvement(f_vals)
def _get_kink_points(self):
raise NotImplementedError("This method should be implemented in the child class")
def distance_to_pareto_front(self, f_vals, ref_factor=1):
"""Return the distance to the Pareto front of the archive,
by calculating the distances to the kink points
>>> from moarchiving.get_archive import get_mo_archive
>>> moa = get_mo_archive([[1, 2, 3], [3, 2, 1], [2, 2, 2]], reference_point=[5, 5, 5])
>>> moa.distance_to_pareto_front([1, 2, 3])
0.0
>>> moa.distance_to_pareto_front([3, 2, 3])
0.0
>>> moa.distance_to_pareto_front([3, 3, 3])
1.0
"""
if self.in_domain(f_vals) and not self.dominates(f_vals):
return 0 # return minimum distance
if self.reference_point is not None:
ref_di = [ref_factor * max((0, f_vals[i] - self.reference_point[i]))
for i in range(self.n_obj)]
else:
ref_di = [0] * self.n_obj
if len(self) == 0:
return sum([ref_di[i] ** 2 for i in range(self.n_obj)]) ** 0.5
if self._kink_points is None:
self._kink_points = self._get_kink_points()
distances_squared = []
for point in self._kink_points:
distances_squared.append(sum([max((0, f_vals[i] - point[i])) ** 2
for i in range(self.n_obj)]))
return min(distances_squared) ** 0.5
def distance_to_hypervolume_area(self, f_vals):
"""Return the distance to the hypervolume area of the archive
>>> from moarchiving.get_archive import get_mo_archive
>>> moa = get_mo_archive(reference_point=[1, 1, 1])
>>> moa.distance_to_hypervolume_area([1, 2, 1])
1.0
>>> moa.distance_to_hypervolume_area([1, 1, 1])
0.0
>>> moa.distance_to_hypervolume_area([0, 0, 0])
0.0
>>> moa.distance_to_hypervolume_area([4, 5, 1])
5.0
"""
if self.reference_point is None:
return 0
return sum([max((0, f_vals[i] - self.reference_point[i])) ** 2
for i in range(self.n_obj)])**0.5
def hypervolume_improvement(self, f_vals):
raise NotImplementedError("This method should be implemented in the child class")
def _set_HV(self):
"""Set the hypervolume of the archive """
if self.reference_point is None:
return None
self._hypervolume = self.hypervolume_final_float_type(self.compute_hypervolume())
if self._hypervolume > 0:
self._hypervolume_plus = self._hypervolume
return self._hypervolume
def compute_hypervolume(self):
raise NotImplementedError("This method should be implemented in the child class")
if __name__ == "__main__":
import doctest
print('doctest.testmod() in moarchiving_parent.py')
print(doctest.testmod())
|
