linpy/polyhedra.py

   1 # Copyright 2014 MINES ParisTech
   2 #
   3 # This file is part of LinPy.
   4 #
   5 # LinPy is free software: you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation, either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # LinPy is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with LinPy.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 import functools
  19 import math
  20 import numbers
  21
  22 from . import islhelper
  23
  24 from .islhelper import mainctx, libisl
  25 from .geometry import GeometricObject, Point
  26 from .linexprs import LinExpr, Rational
  27 from .domains import Domain
  28
  29
  30 __all__ = [
  31     'Polyhedron',
  32     'Lt', 'Le', 'Eq', 'Ne', 'Ge', 'Gt',
  33     'Empty', 'Universe',
  34 ]
  35
  36
  37 class Polyhedron(Domain):
  38     """
  39     A convex polyhedron (or simply "polyhedron") is the space defined by a
  40     system of linear equalities and inequalities. This space can be
  41     unbounded.
  42     """
  43
  44     __slots__ = (
  45         '_equalities',
  46         '_inequalities',
  47         '_symbols',
  48         '_dimension',
  49     )
  50
  51     def __new__(cls, equalities=None, inequalities=None):
  52         """
  53         Return a polyhedron from two sequences of linear expressions: equalities
  54         is a list of expressions equal to 0, and inequalities is a list of
  55         expressions greater or equal to 0. For example, the polyhedron
  56         0 <= x <= 2, 0 <= y <= 2 can be constructed with:
  57
  58         >>> x, y = symbols('x y')
  59         >>> square = Polyhedron([], [x, 2 - x, y, 2 - y])
  60
  61         It may be easier to use comparison operators LinExpr.__lt__(),
  62         LinExpr.__le__(), LinExpr.__ge__(), LinExpr.__gt__(), or functions Lt(),
  63         Le(), Eq(), Ge() and Gt(), using one of the following instructions:
  64
  65         >>> x, y = symbols('x y')
  66         >>> square = (0 <= x) & (x <= 2) & (0 <= y) & (y <= 2)
  67         >>> square = Le(0, x, 2) & Le(0, y, 2)
  68
  69         It is also possible to build a polyhedron from a string.
  70
  71         >>> square = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
  72
  73         Finally, a polyhedron can be constructed from a GeometricObject
  74         instance, calling the GeometricObject.aspolyedron() method. This way, it
  75         is possible to compute the polyhedral hull of a Domain instance, i.e.,
  76         the convex hull of two polyhedra:
  77
  78         >>> square = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
  79         >>> square2 = Polyhedron('2 <= x <= 4, 2 <= y <= 4')
  80         >>> Polyhedron(square | square2)
  81         """
  82         if isinstance(equalities, str):
  83             if inequalities is not None:
  84                 raise TypeError('too many arguments')
  85             return cls.fromstring(equalities)
  86         elif isinstance(equalities, GeometricObject):
  87             if inequalities is not None:
  88                 raise TypeError('too many arguments')
  89             return equalities.aspolyhedron()
  90         sc_equalities = []
  91         if equalities is not None:
  92             for equality in equalities:
  93                 if not isinstance(equality, LinExpr):
  94                     raise TypeError('equalities must be linear expressions')
  95                 sc_equalities.append(equality.scaleint())
  96         sc_inequalities = []
  97         if inequalities is not None:
  98             for inequality in inequalities:
  99                 if not isinstance(inequality, LinExpr):
 100                     raise TypeError('inequalities must be linear expressions')
 101                 sc_inequalities.append(inequality.scaleint())
 102         symbols = cls._xsymbols(sc_equalities + sc_inequalities)
 103         islbset = cls._toislbasicset(sc_equalities, sc_inequalities, symbols)
 104         return cls._fromislbasicset(islbset, symbols)
 105
 106     @property
 107     def equalities(self):
 108         """
 109         The tuple of equalities. This is a list of LinExpr instances that are
 110         equal to 0 in the polyhedron.
 111         """
 112         return self._equalities
 113
 114     @property
 115     def inequalities(self):
 116         """
 117         The tuple of inequalities. This is a list of LinExpr instances that are
 118         greater or equal to 0 in the polyhedron.
 119         """
 120         return self._inequalities
 121
 122     @property
 123     def constraints(self):
 124         """
 125         The tuple of constraints, i.e., equalities and inequalities. This is
 126         semantically equivalent to: equalities + inequalities.
 127         """
 128         return self._equalities + self._inequalities
 129
 130     @property
 131     def polyhedra(self):
 132         return self,
 133
 134     def make_disjoint(self):
 135         return self
 136
 137     def isuniverse(self):
 138         islbset = self._toislbasicset(self.equalities, self.inequalities,
 139             self.symbols)
 140         universe = bool(libisl.isl_basic_set_is_universe(islbset))
 141         libisl.isl_basic_set_free(islbset)
 142         return universe
 143
 144     def aspolyhedron(self):
 145         return self
 146
 147     def convex_union(self, *others):
 148         """
 149         Return the convex union of two or more polyhedra.
 150         """
 151         for other in others:
 152             if not isinstance(other, Polyhedron):
 153                 raise TypeError('arguments must be Polyhedron instances')
 154         return Polyhedron(self.union(*others))
 155
 156     def __contains__(self, point):
 157         if not isinstance(point, Point):
 158             raise TypeError('point must be a Point instance')
 159         if self.symbols != point.symbols:
 160             raise ValueError('arguments must belong to the same space')
 161         for equality in self.equalities:
 162             if equality.subs(point.coordinates()) != 0:
 163                 return False
 164         for inequality in self.inequalities:
 165             if inequality.subs(point.coordinates()) < 0:
 166                 return False
 167         return True
 168
 169     def subs(self, symbol, expression=None):
 170         equalities = [equality.subs(symbol, expression)
 171             for equality in self.equalities]
 172         inequalities = [inequality.subs(symbol, expression)
 173             for inequality in self.inequalities]
 174         return Polyhedron(equalities, inequalities)
 175
 176     def asinequalities(self):
 177         """
 178         Express the polyhedron using inequalities, given as a list of
 179         expressions greater or equal to 0.
 180         """
 181         inequalities = list(self.equalities)
 182         inequalities.extend([-expression for expression in self.equalities])
 183         inequalities.extend(self.inequalities)
 184         return inequalities
 185
 186     def widen(self, other):
 187         """
 188         Compute the standard widening of two polyhedra, à la Halbwachs.
 189
 190         In its current implementation, this method is slow and should not be
 191         used on large polyhedra.
 192         """
 193         if not isinstance(other, Polyhedron):
 194             raise TypeError('argument must be a Polyhedron instance')
 195         inequalities1 = self.asinequalities()
 196         inequalities2 = other.asinequalities()
 197         inequalities = []
 198         for inequality1 in inequalities1:
 199             if other <= Polyhedron(inequalities=[inequality1]):
 200                 inequalities.append(inequality1)
 201         for inequality2 in inequalities2:
 202             for i in range(len(inequalities1)):
 203                 inequalities3 = inequalities1[:i] + inequalities[i + 1:]
 204                 inequalities3.append(inequality2)
 205                 polyhedron3 = Polyhedron(inequalities=inequalities3)
 206                 if self == polyhedron3:
 207                     inequalities.append(inequality2)
 208                     break
 209         return Polyhedron(inequalities=inequalities)
 210
 211     @classmethod
 212     def _fromislbasicset(cls, islbset, symbols):
 213         islconstraints = islhelper.isl_basic_set_constraints(islbset)
 214         equalities = []
 215         inequalities = []
 216         for islconstraint in islconstraints:
 217             constant = libisl.isl_constraint_get_constant_val(islconstraint)
 218             constant = islhelper.isl_val_to_int(constant)
 219             coefficients = {}
 220             for index, symbol in enumerate(symbols):
 221                 coefficient = libisl.isl_constraint_get_coefficient_val(islconstraint,
 222                     libisl.isl_dim_set, index)
 223                 coefficient = islhelper.isl_val_to_int(coefficient)
 224                 if coefficient != 0:
 225                     coefficients[symbol] = coefficient
 226             expression = LinExpr(coefficients, constant)
 227             if libisl.isl_constraint_is_equality(islconstraint):
 228                 equalities.append(expression)
 229             else:
 230                 inequalities.append(expression)
 231         libisl.isl_basic_set_free(islbset)
 232         self = object().__new__(Polyhedron)
 233         self._equalities = tuple(equalities)
 234         self._inequalities = tuple(inequalities)
 235         self._symbols = cls._xsymbols(self.constraints)
 236         self._dimension = len(self._symbols)
 237         return self
 238
 239     @classmethod
 240     def _toislbasicset(cls, equalities, inequalities, symbols):
 241         dimension = len(symbols)
 242         indices = {symbol: index for index, symbol in enumerate(symbols)}
 243         islsp = libisl.isl_space_set_alloc(mainctx, 0, dimension)
 244         islbset = libisl.isl_basic_set_universe(libisl.isl_space_copy(islsp))
 245         islls = libisl.isl_local_space_from_space(islsp)
 246         for equality in equalities:
 247             isleq = libisl.isl_equality_alloc(libisl.isl_local_space_copy(islls))
 248             for symbol, coefficient in equality.coefficients():
 249                 islval = str(coefficient).encode()
 250                 islval = libisl.isl_val_read_from_str(mainctx, islval)
 251                 index = indices[symbol]
 252                 isleq = libisl.isl_constraint_set_coefficient_val(isleq,
 253                     libisl.isl_dim_set, index, islval)
 254             if equality.constant != 0:
 255                 islval = str(equality.constant).encode()
 256                 islval = libisl.isl_val_read_from_str(mainctx, islval)
 257                 isleq = libisl.isl_constraint_set_constant_val(isleq, islval)
 258             islbset = libisl.isl_basic_set_add_constraint(islbset, isleq)
 259         for inequality in inequalities:
 260             islin = libisl.isl_inequality_alloc(libisl.isl_local_space_copy(islls))
 261             for symbol, coefficient in inequality.coefficients():
 262                 islval = str(coefficient).encode()
 263                 islval = libisl.isl_val_read_from_str(mainctx, islval)
 264                 index = indices[symbol]
 265                 islin = libisl.isl_constraint_set_coefficient_val(islin,
 266                     libisl.isl_dim_set, index, islval)
 267             if inequality.constant != 0:
 268                 islval = str(inequality.constant).encode()
 269                 islval = libisl.isl_val_read_from_str(mainctx, islval)
 270                 islin = libisl.isl_constraint_set_constant_val(islin, islval)
 271             islbset = libisl.isl_basic_set_add_constraint(islbset, islin)
 272         return islbset
 273
 274     @classmethod
 275     def fromstring(cls, string):
 276         domain = Domain.fromstring(string)
 277         if not isinstance(domain, Polyhedron):
 278             raise ValueError('non-polyhedral expression: {!r}'.format(string))
 279         return domain
 280
 281     def __repr__(self):
 282         strings = []
 283         for equality in self.equalities:
 284             strings.append('Eq({}, 0)'.format(equality))
 285         for inequality in self.inequalities:
 286             strings.append('Ge({}, 0)'.format(inequality))
 287         if len(strings) == 1:
 288             return strings[0]
 289         else:
 290             return 'And({})'.format(', '.join(strings))
 291
 292     def _repr_latex_(self):
 293         strings = []
 294         for equality in self.equalities:
 295             strings.append('{} = 0'.format(equality._repr_latex_().strip('$')))
 296         for inequality in self.inequalities:
 297             strings.append('{} \\ge 0'.format(inequality._repr_latex_().strip('$')))
 298         return '$${}$$'.format(' \\wedge '.join(strings))
 299
 300     @classmethod
 301     def fromsympy(cls, expr):
 302         domain = Domain.fromsympy(expr)
 303         if not isinstance(domain, Polyhedron):
 304             raise ValueError('non-polyhedral expression: {!r}'.format(expr))
 305         return domain
 306
 307     def tosympy(self):
 308         import sympy
 309         constraints = []
 310         for equality in self.equalities:
 311             constraints.append(sympy.Eq(equality.tosympy(), 0))
 312         for inequality in self.inequalities:
 313             constraints.append(sympy.Ge(inequality.tosympy(), 0))
 314         return sympy.And(*constraints)
 315
 316
 317 class EmptyType(Polyhedron):
 318     """
 319     The empty polyhedron, whose set of constraints is not satisfiable.
 320     """
 321
 322     def __new__(cls):
 323         self = object().__new__(cls)
 324         self._equalities = (Rational(1),)
 325         self._inequalities = ()
 326         self._symbols = ()
 327         self._dimension = 0
 328         return self
 329
 330     def widen(self, other):
 331         if not isinstance(other, Polyhedron):
 332             raise ValueError('argument must be a Polyhedron instance')
 333         return other
 334
 335     def __repr__(self):
 336         return 'Empty'
 337
 338     def _repr_latex_(self):
 339         return '$$\\emptyset$$'
 340
 341 Empty = EmptyType()
 342
 343
 344 class UniverseType(Polyhedron):
 345     """
 346     The universe polyhedron, whose set of constraints is always satisfiable,
 347     i.e. is empty.
 348     """
 349
 350     def __new__(cls):
 351         self = object().__new__(cls)
 352         self._equalities = ()
 353         self._inequalities = ()
 354         self._symbols = ()
 355         self._dimension = ()
 356         return self
 357
 358     def __repr__(self):
 359         return 'Universe'
 360
 361     def _repr_latex_(self):
 362         return '$$\\Omega$$'
 363
 364 Universe = UniverseType()
 365
 366
 367 def _polymorphic(func):
 368     @functools.wraps(func)
 369     def wrapper(left, right):
 370         if not isinstance(left, LinExpr):
 371             if isinstance(left, numbers.Rational):
 372                 left = Rational(left)
 373             else:
 374                 raise TypeError('left must be a a rational number '
 375                     'or a linear expression')
 376         if not isinstance(right, LinExpr):
 377             if isinstance(right, numbers.Rational):
 378                 right = Rational(right)
 379             else:
 380                 raise TypeError('right must be a a rational number '
 381                     'or a linear expression')
 382         return func(left, right)
 383     return wrapper
 384
 385 @_polymorphic
 386 def Lt(left, right):
 387     """
 388     Create the polyhedron with constraints expr1 < expr2 < expr3 ...
 389     """
 390     return Polyhedron([], [right - left - 1])
 391
 392 @_polymorphic
 393 def Le(left, right):
 394     """
 395     Create the polyhedron with constraints expr1 <= expr2 <= expr3 ...
 396     """
 397     return Polyhedron([], [right - left])
 398
 399 @_polymorphic
 400 def Eq(left, right):
 401     """
 402     Create the polyhedron with constraints expr1 == expr2 == expr3 ...
 403     """
 404     return Polyhedron([left - right], [])
 405
 406 @_polymorphic
 407 def Ne(left, right):
 408     """
 409     Create the domain such that expr1 != expr2 != expr3 ... The result is a
 410     Domain, not a Polyhedron.
 411     """
 412     return ~Eq(left, right)
 413
 414 @_polymorphic
 415 def Ge(left, right):
 416     """
 417     Create the polyhedron with constraints expr1 >= expr2 >= expr3 ...
 418     """
 419     return Polyhedron([], [left - right])
 420
 421 @_polymorphic
 422 def Gt(left, right):
 423     """
 424     Create the polyhedron with constraints expr1 > expr2 > expr3 ...
 425     """
 426     return Polyhedron([], [left - right - 1])