author Vivien Maisonneuve Wed, 20 Aug 2014 12:01:19 +0000 (14:01 +0200) committer Vivien Maisonneuve Wed, 20 Aug 2014 12:01:19 +0000 (14:01 +0200)
 linpy/domains.py patch | blob | history linpy/linexprs.py patch | blob | history linpy/polyhedra.py patch | blob | history

index 581a065..1f7a190 100644 (file)
@@ -54,22 +54,23 @@ class Domain(GeometricObject):
"""
Return a domain from a sequence of polyhedra.

-        >>> square = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
-        >>> square2 = Polyhedron('2 <= x <= 4, 2 <= y <= 4')
-        >>> dom = Domain([square, square2])
+        >>> square1 = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
+        >>> square2 = Polyhedron('1 <= x <= 3, 1 <= y <= 3')
+        >>> dom = Domain(square1, square2)
+        >>> dom
+        Or(And(x <= 2, 0 <= x, y <= 2, 0 <= y),
+           And(x <= 3, 1 <= x, y <= 3, 1 <= y))

It is also possible to build domains from polyhedra using arithmetic
-        operators Domain.__and__(), Domain.__or__() or functions And() and Or(),
-        using one of the following instructions:
+        operators Domain.__or__(), Domain.__invert__() or functions Or() and
+        Not(), using one of the following instructions:

-        >>> square = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
-        >>> square2 = Polyhedron('2 <= x <= 4, 2 <= y <= 4')
-        >>> dom = square | square2
-        >>> dom = Or(square, square2)
+        >>> dom = square1 | square2
+        >>> dom = Or(square1, square2)

Alternatively, a domain can be built from a string:

-        >>> dom = Domain('0 <= x <= 2, 0 <= y <= 2; 2 <= x <= 4, 2 <= y <= 4')
+        >>> dom = Domain('0 <= x <= 2, 0 <= y <= 2; 1 <= x <= 3, 1 <= y <= 3')

Finally, a domain can be built from a GeometricObject instance, calling
the GeometricObject.asdomain() method.
index a0be583..eff4a7e 100644 (file)
@@ -62,7 +62,7 @@ class LinExpr:
symbols to their coefficients, and a constant term. The coefficients and
the constant term must be rational numbers.

-        For example, the linear expression x + 2y + 1 can be constructed using
+        For example, the linear expression x + 2*y + 1 can be constructed using
one of the following instructions:

>>> x, y = symbols('x y')
@@ -76,7 +76,7 @@ class LinExpr:

Alternatively, linear expressions can be constructed from a string:

-        >>> LinExpr('x + 2*y + 1')
+        >>> LinExpr('x + 2y + 1')

A linear expression with a single symbol of coefficient 1 and no
constant term is automatically subclassed as a Symbol instance. A linear
@@ -245,7 +245,11 @@ class LinExpr:
@_polymorphic
def __eq__(self, other):
"""
-        Test whether two linear expressions are equal.
+        Test whether two linear expressions are equal. Unlike methods
+        LinExpr.__lt__(), LinExpr.__le__(), LinExpr.__ge__(), LinExpr.__gt__(),
+        the result is a boolean value, not a polyhedron. To express that two
+        linear expressions are equal or not equal, use functions Eq() and Ne()
"""
return self._coefficients == other._coefficients and \
self._constant == other._constant
index bfc7efe..4d7d1f3 100644 (file)
@@ -56,28 +56,31 @@ class Polyhedron(Domain):
0 <= x <= 2, 0 <= y <= 2 can be constructed with:

>>> x, y = symbols('x y')
-        >>> square = Polyhedron([], [x, 2 - x, y, 2 - y])
+        >>> square1 = Polyhedron([], [x, 2 - x, y, 2 - y])
+        >>> square1
+        And(0 <= x, x <= 2, 0 <= y, y <= 2)

It may be easier to use comparison operators LinExpr.__lt__(),
LinExpr.__le__(), LinExpr.__ge__(), LinExpr.__gt__(), or functions Lt(),
Le(), Eq(), Ge() and Gt(), using one of the following instructions:

>>> x, y = symbols('x y')
-        >>> square = (0 <= x) & (x <= 2) & (0 <= y) & (y <= 2)
-        >>> square = Le(0, x, 2) & Le(0, y, 2)
+        >>> square1 = (0 <= x) & (x <= 2) & (0 <= y) & (y <= 2)
+        >>> square1 = Le(0, x, 2) & Le(0, y, 2)

It is also possible to build a polyhedron from a string.

-        >>> square = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
+        >>> square1 = Polyhedron('0 <= x <= 2, 0 <= y <= 2')

Finally, a polyhedron can be constructed from a GeometricObject
instance, calling the GeometricObject.aspolyedron() method. This way, it
is possible to compute the polyhedral hull of a Domain instance, i.e.,
the convex hull of two polyhedra:

-        >>> square = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
-        >>> square2 = Polyhedron('2 <= x <= 4, 2 <= y <= 4')
-        >>> Polyhedron(square | square2)
+        >>> square1 = Polyhedron('0 <= x <= 2, 0 <= y <= 2')
+        >>> square2 = Polyhedron('1 <= x <= 3, 1 <= y <= 3')
+        >>> Polyhedron(square1 | square2)
+        And(0 <= x, 0 <= y, x <= y + 2, y <= x + 2, x <= 3, y <= 3)
"""
if isinstance(equalities, str):
if inequalities is not None: