05c9c8fc7886369e9654dbda9f7354762a716dbb
[linpy.git] / pypol / domains.py
1 import ast
2 import functools
3 import re
4
5 from . import islhelper
6
7 from .islhelper import mainctx, libisl, isl_set_basic_sets
8 from .linexprs import Expression, Symbol
9
10
11 __all__ = [
12 'Domain',
13 'And', 'Or', 'Not',
14 ]
15
16
17 @functools.total_ordering
18 class Domain:
19
20 __slots__ = (
21 '_polyhedra',
22 '_symbols',
23 '_dimension',
24 )
25
26 def __new__(cls, *polyhedra):
27 from .polyhedra import Polyhedron
28 if len(polyhedra) == 1:
29 polyhedron = polyhedra[0]
30 if isinstance(polyhedron, str):
31 return cls.fromstring(polyhedron)
32 elif isinstance(polyhedron, Polyhedron):
33 return polyhedron
34 else:
35 raise TypeError('argument must be a string '
36 'or a Polyhedron instance')
37 else:
38 for polyhedron in polyhedra:
39 if not isinstance(polyhedron, Polyhedron):
40 raise TypeError('arguments must be Polyhedron instances')
41 symbols = cls._xsymbols(polyhedra)
42 islset = cls._toislset(polyhedra, symbols)
43 return cls._fromislset(islset, symbols)
44
45 @classmethod
46 def _xsymbols(cls, iterator):
47 """
48 Return the ordered tuple of symbols present in iterator.
49 """
50 symbols = set()
51 for item in iterator:
52 symbols.update(item.symbols)
53 return tuple(sorted(symbols, key=Symbol.sortkey))
54
55 @property
56 def polyhedra(self):
57 return self._polyhedra
58
59 @property
60 def symbols(self):
61 return self._symbols
62
63 @property
64 def dimension(self):
65 return self._dimension
66
67 def disjoint(self):
68 islset = self._toislset(self.polyhedra, self.symbols)
69 islset = libisl.isl_set_make_disjoint(mainctx, islset)
70 return self._fromislset(islset, self.symbols)
71
72 def isempty(self):
73 islset = self._toislset(self.polyhedra, self.symbols)
74 empty = bool(libisl.isl_set_is_empty(islset))
75 libisl.isl_set_free(islset)
76 return empty
77
78 def __bool__(self):
79 return not self.isempty()
80
81 def isuniverse(self):
82 islset = self._toislset(self.polyhedra, self.symbols)
83 universe = bool(libisl.isl_set_plain_is_universe(islset))
84 libisl.isl_set_free(islset)
85 return universe
86
87 def isbounded(self):
88 islset = self._toislset(self.polyhedra, self.symbols)
89 bounded = bool(libisl.isl_set_is_bounded(islset))
90 libisl.isl_set_free(islset)
91 return bounded
92
93 def __eq__(self, other):
94 symbols = self._xsymbols([self, other])
95 islset1 = self._toislset(self.polyhedra, symbols)
96 islset2 = other._toislset(other.polyhedra, symbols)
97 equal = bool(libisl.isl_set_is_equal(islset1, islset2))
98 libisl.isl_set_free(islset1)
99 libisl.isl_set_free(islset2)
100 return equal
101
102 def isdisjoint(self, other):
103 symbols = self._xsymbols([self, other])
104 islset1 = self._toislset(self.polyhedra, symbols)
105 islset2 = self._toislset(other.polyhedra, symbols)
106 equal = bool(libisl.isl_set_is_disjoint(islset1, islset2))
107 libisl.isl_set_free(islset1)
108 libisl.isl_set_free(islset2)
109 return equal
110
111 def issubset(self, other):
112 symbols = self._xsymbols([self, other])
113 islset1 = self._toislset(self.polyhedra, symbols)
114 islset2 = self._toislset(other.polyhedra, symbols)
115 equal = bool(libisl.isl_set_is_subset(islset1, islset2))
116 libisl.isl_set_free(islset1)
117 libisl.isl_set_free(islset2)
118 return equal
119
120 def __le__(self, other):
121 return self.issubset(other)
122
123 def __lt__(self, other):
124 symbols = self._xsymbols([self, other])
125 islset1 = self._toislset(self.polyhedra, symbols)
126 islset2 = self._toislset(other.polyhedra, symbols)
127 equal = bool(libisl.isl_set_is_strict_subset(islset1, islset2))
128 libisl.isl_set_free(islset1)
129 libisl.isl_set_free(islset2)
130 return equal
131
132 def complement(self):
133 islset = self._toislset(self.polyhedra, self.symbols)
134 islset = libisl.isl_set_complement(islset)
135 return self._fromislset(islset, self.symbols)
136
137 def __invert__(self):
138 return self.complement()
139
140 def simplify(self):
141 #does not change anything in any of the examples
142 #isl seems to do this naturally
143 islset = self._toislset(self.polyhedra, self.symbols)
144 islset = libisl.isl_set_remove_redundancies(islset)
145 return self._fromislset(islset, self.symbols)
146
147 def polyhedral_hull(self):
148 # several types of hull are available
149 # polyhedral seems to be the more appropriate, to be checked
150 from .polyhedra import Polyhedron
151 islset = self._toislset(self.polyhedra, self.symbols)
152 islbset = libisl.isl_set_polyhedral_hull(islset)
153 return Polyhedron._fromislbasicset(islbset, self.symbols)
154
155 def project_out(self, dims):
156 # use to remove certain variables
157 islset = self._toislset(self.polyhedra, self.symbols)
158 n = 0
159 for index, symbol in reversed(list(enumerate(self.symbols))):
160 if symbol in dims:
161 n += 1
162 elif n > 0:
163 islset = libisl.isl_set_project_out(islset, libisl.isl_dim_set, index + 1, n)
164 n = 0
165 if n > 0:
166 islset = libisl.isl_set_project_out(islset, libisl.isl_dim_set, 0, n)
167 dims = [symbol for symbol in self.symbols if symbol not in dims]
168 return Domain._fromislset(islset, dims)
169
170 def sample(self):
171 from .polyhedra import Polyhedron
172 islset = self._toislset(self.polyhedra, self.symbols)
173 islbset = libisl.isl_set_sample(islset)
174 # next instruction should NOT be required
175 islbset = libisl.isl_basic_set_finalize(islbset)
176 return Polyhedron._fromislbasicset(islbset, self.symbols)
177
178 def intersection(self, *others):
179 if len(others) == 0:
180 return self
181 symbols = self._xsymbols((self,) + others)
182 islset1 = self._toislset(self.polyhedra, symbols)
183 for other in others:
184 islset2 = other._toislset(other.polyhedra, symbols)
185 islset1 = libisl.isl_set_intersect(islset1, islset2)
186 return self._fromislset(islset1, symbols)
187
188 def __and__(self, other):
189 return self.intersection(other)
190
191 def union(self, *others):
192 if len(others) == 0:
193 return self
194 symbols = self._xsymbols((self,) + others)
195 islset1 = self._toislset(self.polyhedra, symbols)
196 for other in others:
197 islset2 = other._toislset(other.polyhedra, symbols)
198 islset1 = libisl.isl_set_union(islset1, islset2)
199 return self._fromislset(islset1, symbols)
200
201 def __or__(self, other):
202 return self.union(other)
203
204 def __add__(self, other):
205 return self.union(other)
206
207 def difference(self, other):
208 symbols = self._xsymbols([self, other])
209 islset1 = self._toislset(self.polyhedra, symbols)
210 islset2 = other._toislset(other.polyhedra, symbols)
211 islset = libisl.isl_set_subtract(islset1, islset2)
212 return self._fromislset(islset, symbols)
213
214 def __sub__(self, other):
215 return self.difference(other)
216
217 def lexmin(self):
218 islset = self._toislset(self.polyhedra, self.symbols)
219 islset = libisl.isl_set_lexmin(islset)
220 return self._fromislset(islset, self.symbols)
221
222 def lexmax(self):
223 islset = self._toislset(self.polyhedra, self.symbols)
224 islset = libisl.isl_set_lexmax(islset)
225 return self._fromislset(islset, self.symbols)
226
227 def num_parameters(self):
228 #could be useful with large, complicated polyhedrons
229 islbset = self._toislbasicset(self.equalities, self.inequalities, self.symbols)
230 num = libisl.isl_basic_set_dim(islbset, libisl.isl_dim_set)
231 return num
232
233 def involves_dims(self, dims):
234 #could be useful with large, complicated polyhedrons
235 islset = self._toislset(self.polyhedra, self.symbols)
236 dims = sorted(dims)
237 symbols = sorted(list(self.symbols))
238 n = 0
239 if len(dims)>0:
240 for dim in dims:
241 if dim in symbols:
242 first = symbols.index(dims[0])
243 n +=1
244 else:
245 first = 0
246 else:
247 return False
248 value = bool(libisl.isl_set_involves_dims(islset, libisl.isl_dim_set, first, n))
249 libisl.isl_set_free(islset)
250 return value
251
252 def vertices(self):
253 if self.isbounded():
254 islbset = self._toislbasicset(self.equalities, self.inequalities, self.symbols)
255 vertices = libisl.isl_basic_set_compute_vertices(islbset);
256 vertexes = islhelper.isl_vertices_vertices(vertices)
257 #vertex = libisl.isl_vertices_get_n_vertices(vertices)
258 for verts in vertexes:
259 expr = libisl.isl_vertex_get_expr(verts);
260 this = islhelper.isl_set_to_str(expr)
261 print(this)
262 else:
263 raise TypeError('set must be bounded')
264 return string
265
266 def points(self):
267 bounds = {}
268 coordinates = []
269 symbols = self.symbols
270 if self.isbounded():
271 islset = self._toislset(self.polyhedra, self.symbols)
272 points = islhelper.isl_set_points(islset)
273 for sym in symbols:
274 for point in points:
275 coordinate = libisl.isl_point_get_coordinate_val(point, libisl.isl_dim_set, symbols.index(sym))
276 coordinate = islhelper.isl_val_to_int(coordinate)
277 coordinates.append(coordinate)
278 else:
279 raise TypeError('set must be bounded')
280 return coordinates
281
282 @classmethod
283 def _fromislset(cls, islset, symbols):
284 from .polyhedra import Polyhedron
285 islset = libisl.isl_set_remove_divs(islset)
286 islbsets = isl_set_basic_sets(islset)
287 libisl.isl_set_free(islset)
288 polyhedra = []
289 for islbset in islbsets:
290 polyhedron = Polyhedron._fromislbasicset(islbset, symbols)
291 polyhedra.append(polyhedron)
292 if len(polyhedra) == 0:
293 from .polyhedra import Empty
294 return Empty
295 elif len(polyhedra) == 1:
296 return polyhedra[0]
297 else:
298 self = object().__new__(Domain)
299 self._polyhedra = tuple(polyhedra)
300 self._symbols = cls._xsymbols(polyhedra)
301 self._dimension = len(self._symbols)
302 return self
303
304 def _toislset(cls, polyhedra, symbols):
305 polyhedron = polyhedra[0]
306 islbset = polyhedron._toislbasicset(polyhedron.equalities,
307 polyhedron.inequalities, symbols)
308 islset1 = libisl.isl_set_from_basic_set(islbset)
309 for polyhedron in polyhedra[1:]:
310 islbset = polyhedron._toislbasicset(polyhedron.equalities,
311 polyhedron.inequalities, symbols)
312 islset2 = libisl.isl_set_from_basic_set(islbset)
313 islset1 = libisl.isl_set_union(islset1, islset2)
314 return islset1
315
316 @classmethod
317 def _fromast(cls, node):
318 from .polyhedra import Polyhedron
319 if isinstance(node, ast.Module) and len(node.body) == 1:
320 return cls._fromast(node.body[0])
321 elif isinstance(node, ast.Expr):
322 return cls._fromast(node.value)
323 elif isinstance(node, ast.UnaryOp):
324 domain = cls._fromast(node.operand)
325 if isinstance(node.operand, ast.invert):
326 return Not(domain)
327 elif isinstance(node, ast.BinOp):
328 domain1 = cls._fromast(node.left)
329 domain2 = cls._fromast(node.right)
330 if isinstance(node.op, ast.BitAnd):
331 return And(domain1, domain2)
332 elif isinstance(node.op, ast.BitOr):
333 return Or(domain1, domain2)
334 elif isinstance(node, ast.Compare):
335 equalities = []
336 inequalities = []
337 left = Expression._fromast(node.left)
338 for i in range(len(node.ops)):
339 op = node.ops[i]
340 right = Expression._fromast(node.comparators[i])
341 if isinstance(op, ast.Lt):
342 inequalities.append(right - left - 1)
343 elif isinstance(op, ast.LtE):
344 inequalities.append(right - left)
345 elif isinstance(op, ast.Eq):
346 equalities.append(left - right)
347 elif isinstance(op, ast.GtE):
348 inequalities.append(left - right)
349 elif isinstance(op, ast.Gt):
350 inequalities.append(left - right - 1)
351 else:
352 break
353 left = right
354 else:
355 return Polyhedron(equalities, inequalities)
356 raise SyntaxError('invalid syntax')
357
358 _RE_BRACES = re.compile(r'^\{\s*|\s*\}$')
359 _RE_EQ = re.compile(r'([^<=>])=([^<=>])')
360 _RE_AND = re.compile(r'\band\b|,|&&|/\\|∧|∩')
361 _RE_OR = re.compile(r'\bor\b|;|\|\||\\/|∨|∪')
362 _RE_NOT = re.compile(r'\bnot\b|!|¬')
363 _RE_NUM_VAR = Expression._RE_NUM_VAR
364 _RE_OPERATORS = re.compile(r'(&|\||~)')
365
366 @classmethod
367 def fromstring(cls, string):
368 # remove curly brackets
369 string = cls._RE_BRACES.sub(r'', string)
370 # replace '=' by '=='
371 string = cls._RE_EQ.sub(r'\1==\2', string)
372 # replace 'and', 'or', 'not'
373 string = cls._RE_AND.sub(r' & ', string)
374 string = cls._RE_OR.sub(r' | ', string)
375 string = cls._RE_NOT.sub(r' ~', string)
376 # add implicit multiplication operators, e.g. '5x' -> '5*x'
377 string = cls._RE_NUM_VAR.sub(r'\1*\2', string)
378 # add parentheses to force precedence
379 tokens = cls._RE_OPERATORS.split(string)
380 for i, token in enumerate(tokens):
381 if i % 2 == 0:
382 token = '({})'.format(token)
383 tokens[i] = token
384 string = ''.join(tokens)
385 tree = ast.parse(string, 'eval')
386 return cls._fromast(tree)
387
388 def __repr__(self):
389 assert len(self.polyhedra) >= 2
390 strings = [repr(polyhedron) for polyhedron in self.polyhedra]
391 return 'Or({})'.format(', '.join(strings))
392
393 @classmethod
394 def fromsympy(cls, expr):
395 import sympy
396 from .polyhedra import Lt, Le, Eq, Ne, Ge, Gt
397 funcmap = {
398 sympy.And: And, sympy.Or: Or, sympy.Not: Not,
399 sympy.Lt: Lt, sympy.Le: Le,
400 sympy.Eq: Eq, sympy.Ne: Ne,
401 sympy.Ge: Ge, sympy.Gt: Gt,
402 }
403 if expr.func in funcmap:
404 args = [Domain.fromsympy(arg) for arg in expr.args]
405 return funcmap[expr.func](*args)
406 elif isinstance(expr, sympy.Expr):
407 return Expression.fromsympy(expr)
408 raise ValueError('non-domain expression: {!r}'.format(expr))
409
410 def tosympy(self):
411 import sympy
412 polyhedra = [polyhedron.tosympy() for polyhedron in polyhedra]
413 return sympy.Or(*polyhedra)
414
415
416 def And(*domains):
417 if len(domains) == 0:
418 from .polyhedra import Universe
419 return Universe
420 else:
421 return domains[0].intersection(*domains[1:])
422
423 def Or(*domains):
424 if len(domains) == 0:
425 from .polyhedra import Empty
426 return Empty
427 else:
428 return domains[0].union(*domains[1:])
429
430 def Not(domain):
431 return ~domain