Remove license and add to doc examples

[linpy.git] / doc / examples.rst

diff --git a/doc/examples.rst b/doc/examples.rst
index ea044b8..3d2626d 100644 (file)
--- a/doc/examples.rst
+++ b/doc/examples.rst
@@ -15,13 +15,16 @@ Basic Examples
 
     Binary operations and properties examples:
 
 
     Binary operations and properties examples:
 

-    >>> square2 = Le(1, x) & Le(x, 3) & Le(1, y) & Le(y, 3)
+    >>> # create a polyhedron from a string
+    >>> square2 = Polyhedron('1 <= x') & Polyhedron('x <= 3') & \
+    Polyhedron('1 <= y') & Polyhedron('y <= 3')

     >>> #test equality
     >>> square1 == square2
     False
     >>> # compute the union of two polyhedrons
     >>> square1 | square2
     >>> #test equality
     >>> square1 == square2
     False
     >>> # compute the union of two polyhedrons
     >>> square1 | square2

-    Or(And(Ge(x, 0), Ge(-x + 2, 0), Ge(y, 0), Ge(-y + 2, 0)), And(Ge(x - 1, 0), Ge(-x + 3, 0), Ge(y - 1, 0), Ge(-y + 3, 0)))
+    Or(And(Ge(x, 0), Ge(-x + 2, 0), Ge(y, 0), Ge(-y + 2, 0)), \
+    And(Ge(x - 1, 0), Ge(-x + 3, 0), Ge(y - 1, 0), Ge(-y + 3, 0)))

     >>> # check if square1 and square2 are disjoint
     >>> square1.disjoint(square2)
     False
     >>> # check if square1 and square2 are disjoint
     >>> square1.disjoint(square2)
     False


@@ -30,12 +33,17 @@ Basic Examples
     And(Ge(x - 1, 0), Ge(-x + 2, 0), Ge(y - 1, 0), Ge(-y + 2, 0))
     >>> # compute the convex union of two polyhedrons
     >>> Polyhedron(square1 | sqaure2)
     And(Ge(x - 1, 0), Ge(-x + 2, 0), Ge(y - 1, 0), Ge(-y + 2, 0))
     >>> # compute the convex union of two polyhedrons
     >>> Polyhedron(square1 | sqaure2)

-    And(Ge(x, 0), Ge(y, 0), Ge(-y + 3, 0), Ge(-x + 3, 0), Ge(x - y + 2, 0), Ge(-x + y + 2, 0))
+    And(Ge(x, 0), Ge(y, 0), Ge(-y + 3, 0), Ge(-x + 3, 0), \
+    Ge(x - y + 2, 0), Ge(-x + y + 2, 0))

 
     Unary operation and properties examples:
 
     >>> square1.isempty()
     False
 
     Unary operation and properties examples:
 
     >>> square1.isempty()
     False

+    >>> # compute the complement of square1
+    >>> ~square1
+    Or(Ge(-x - 1, 0), Ge(x - 3, 0), And(Ge(x, 0), Ge(-x + 2, 0), \
+    Ge(-y - 1, 0)), And(Ge(x, 0), Ge(-x + 2, 0), Ge(y - 3, 0)))

     >>> square1.symbols()
     (x, y)
     >>> square1.inequalities
     >>> square1.symbols()
     (x, y)
     >>> square1.inequalities