-
Notifications
You must be signed in to change notification settings - Fork 20
/
test_custom_shadow_variables.py
232 lines (182 loc) · 8.43 KB
/
test_custom_shadow_variables.py
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
import optapy
import optapy.constraint
import optapy.score
import optapy.config
from optapy.types import ScoreDirector
def test_custom_shadow_variable():
@optapy.variable_listener
class MyVariableListener:
def afterVariableChanged(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
score_director.beforeVariableChanged(entity, 'value_squared')
if entity.value is None:
entity.value_squared = None
else:
entity.value_squared = entity.value ** 2
score_director.afterVariableChanged(entity, 'value_squared')
def beforeVariableChanged(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def beforeEntityAdded(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def afterEntityAdded(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def beforeEntityRemoved(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def afterEntityRemoved(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
@optapy.planning_entity
class MyPlanningEntity:
value: int
value_squared: int
def __init__(self):
self.value = None
self.value_squared = None
@optapy.planning_variable(int, value_range_provider_refs=['value_range'])
def get_value(self):
return self.value
def set_value(self, new_value):
self.value = new_value
@optapy.custom_shadow_variable(int, variable_listener_class=MyVariableListener,
sources=[optapy.planning_variable_reference('value')])
def get_value_squared(self):
return self.value_squared
def set_value_squared(self, new_value_squared):
self.value_squared = new_value_squared
@optapy.constraint_provider
def my_constraints(constraint_factory: optapy.constraint.ConstraintFactory):
return [
constraint_factory.for_each(MyPlanningEntity)
.filter(lambda entity: entity.value * 2 == entity.value_squared)
.reward('Double value is value squared', optapy.score.SimpleScore.ONE)
]
@optapy.planning_solution
class MySolution:
entity_list: list[MyPlanningEntity]
value_list: list[int]
score: optapy.score.SimpleScore
def __init__(self, entity_list, value_list, score=None):
self.entity_list = entity_list
self.value_list = value_list
self.score = score
@optapy.planning_entity_collection_property(MyPlanningEntity)
def get_entity_list(self):
return self.entity_list
def set_entity_list(self, entity_list):
self.entity_list = entity_list
@optapy.problem_fact_collection_property(int)
@optapy.value_range_provider('value_range')
def get_value_list(self):
return self.value_list
def set_value_list(self, value_list):
self.value_list = value_list
@optapy.planning_score(optapy.score.SimpleScore)
def get_score(self):
return self.score
def set_score(self, score):
self.score = score
solver_config = optapy.config.solver.SolverConfig() \
.withSolutionClass(MySolution) \
.withEntityClasses(MyPlanningEntity) \
.withConstraintProviderClass(my_constraints) \
.withTerminationConfig(optapy.config.solver.termination.TerminationConfig()
.withBestScoreLimit('1'))
solver_factory = optapy.solver_factory_create(solver_config)
solver = solver_factory.buildSolver()
problem = MySolution([MyPlanningEntity()], [1, 2, 3])
solution: MySolution = solver.solve(problem)
assert solution.score.getScore() == 1
assert solution.entity_list[0].value == 2
assert solution.entity_list[0].value_squared == 4
def test_custom_shadow_variable_with_variable_listener_ref():
@optapy.variable_listener
class MyVariableListener:
def afterVariableChanged(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
score_director.beforeVariableChanged(entity, 'twice_value')
score_director.beforeVariableChanged(entity, 'value_squared')
if entity.value is None:
entity.twice_value = None
entity.value_squared = None
else:
entity.twice_value = 2 * entity.value
entity.value_squared = entity.value ** 2
score_director.afterVariableChanged(entity, 'value_squared')
score_director.afterVariableChanged(entity, 'twice_value')
def beforeVariableChanged(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def beforeEntityAdded(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def afterEntityAdded(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def beforeEntityRemoved(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
def afterEntityRemoved(self, score_director: ScoreDirector, entity: 'MyPlanningEntity'):
pass
@optapy.planning_entity
class MyPlanningEntity:
value: int
value_squared: int
twice_value: int
def __init__(self):
self.value = None
self.value_squared = None
self.twice_value = None
@optapy.planning_variable(int, value_range_provider_refs=['value_range'])
def get_value(self):
return self.value
def set_value(self, new_value):
self.value = new_value
@optapy.custom_shadow_variable(int, variable_listener_class=MyVariableListener,
sources=[optapy.planning_variable_reference('value')])
def get_value_squared(self):
return self.value_squared
def set_value_squared(self, new_value_squared):
self.value_squared = new_value_squared
@optapy.custom_shadow_variable(int, variable_listener_ref=optapy.planning_variable_reference('value_squared'))
def get_twice_value(self):
return self.twice_value
def set_twice_value(self, twice_value):
self.twice_value = twice_value
@optapy.constraint_provider
def my_constraints(constraint_factory: optapy.constraint.ConstraintFactory):
return [
constraint_factory.for_each(MyPlanningEntity)
.filter(lambda entity: entity.twice_value == entity.value_squared)
.reward('Double value is value squared', optapy.score.SimpleScore.ONE)
]
@optapy.planning_solution
class MySolution:
entity_list: list[MyPlanningEntity]
value_list: list[int]
score: optapy.score.SimpleScore
def __init__(self, entity_list, value_list, score=None):
self.entity_list = entity_list
self.value_list = value_list
self.score = score
@optapy.planning_entity_collection_property(MyPlanningEntity)
def get_entity_list(self):
return self.entity_list
def set_entity_list(self, entity_list):
self.entity_list = entity_list
@optapy.problem_fact_collection_property(int)
@optapy.value_range_provider('value_range')
def get_value_list(self):
return self.value_list
def set_value_list(self, value_list):
self.value_list = value_list
@optapy.planning_score(optapy.score.SimpleScore)
def get_score(self):
return self.score
def set_score(self, score):
self.score = score
solver_config = optapy.config.solver.SolverConfig() \
.withSolutionClass(MySolution) \
.withEntityClasses(MyPlanningEntity) \
.withConstraintProviderClass(my_constraints) \
.withTerminationConfig(optapy.config.solver.termination.TerminationConfig()
.withBestScoreLimit('1'))
solver_factory = optapy.solver_factory_create(solver_config)
solver = solver_factory.buildSolver()
problem = MySolution([MyPlanningEntity()], [1, 2, 3])
solution: MySolution = solver.solve(problem)
assert solution.score.getScore() == 1
assert solution.entity_list[0].value == 2
assert solution.entity_list[0].value_squared == 4