Added some docs

[linpy.git] / pypol / polyhedra.py

diff --git a/pypol/polyhedra.py b/pypol/polyhedra.py
index ccb1a8c..fe143d4 100644 (file)
--- a/pypol/polyhedra.py
+++ b/pypol/polyhedra.py
@@ -56,14 +56,23 @@ class Polyhedron(Domain):
 
     @property
     def equalities(self):
+    """
+    Return a list of the equalities in a set.
+    """
         return self._equalities
 
     @property
     def inequalities(self):
+    """
+    Return a list of the inequalities in a set.
+    """
         return self._inequalities
 
     @property
     def constraints(self):
+    """
+    Return ta list of the constraints of a set.
+    """
         return self._constraints
 
     @property
@@ -72,13 +81,13 @@ class Polyhedron(Domain):
 
     def disjoint(self):
         """
-        Return this set as disjoint.
+        Return a set as disjoint.
         """
         return self
 
     def isuniverse(self):
         """
-        Return true if this set is the Universe set.
+        Return true if a set is the Universe set.
         """
         islbset = self._toislbasicset(self.equalities, self.inequalities,
             self.symbols)
@@ -88,7 +97,7 @@ class Polyhedron(Domain):
 
     def aspolyhedron(self):
         """
-        Return polyhedral hull of this set.
+        Return polyhedral hull of a set.
         """
         return self
 
@@ -106,6 +115,9 @@ class Polyhedron(Domain):
         return True
 
     def subs(self, symbol, expression=None):
+    """
+    Subsitute the given value into an expression and return the resulting expression.
+    """
         equalities = [equality.subs(symbol, expression)
             for equality in self.equalities]
         inequalities = [inequality.subs(symbol, expression)
@@ -139,10 +151,6 @@ class Polyhedron(Domain):
 
     @classmethod
     def _fromislbasicset(cls, islbset, symbols):
-        if libisl.isl_basic_set_is_empty(islbset):
-            return Empty
-        if libisl.isl_basic_set_is_universe(islbset):
-            return Universe
         islconstraints = islhelper.isl_basic_set_constraints(islbset)
         equalities = []
         inequalities = []
@@ -223,6 +231,7 @@ class Polyhedron(Domain):
         else:
             return 'And({})'.format(', '.join(strings))
 
+
     def _repr_latex_(self):
         strings = []
         for equality in self.equalities:
@@ -233,12 +242,18 @@ class Polyhedron(Domain):
 
     @classmethod
     def fromsympy(cls, expr):
+    """
+    Convert a sympy object to an expression.
+    """
         domain = Domain.fromsympy(expr)
         if not isinstance(domain, Polyhedron):
             raise ValueError('non-polyhedral expression: {!r}'.format(expr))
         return domain
 
     def tosympy(self):
+    """
+    Return an expression as a sympy object. 
+    """
         import sympy
         constraints = []
         for equality in self.equalities:
@@ -247,7 +262,6 @@ class Polyhedron(Domain):
             constraints.append(sympy.Ge(inequality.tosympy(), 0))
         return sympy.And(*constraints)
 
-
 class EmptyType(Polyhedron):
 
     __slots__ = Polyhedron.__slots__
@@ -318,41 +332,42 @@ def _polymorphic(func):
 @_polymorphic
 def Lt(left, right):
     """
-    Return true if the first set is less than the second.
+    Assert first set is less than the second set.
     """
     return Polyhedron([], [right - left - 1])
 
 @_polymorphic
 def Le(left, right):
     """
-    Return true the first set is less than or equal to the second.
+    Assert first set is less than or equal to the second set.
     """
     return Polyhedron([], [right - left])
 
 @_polymorphic
 def Eq(left, right):
     """
-    Return true if the sets are equal.
+    Assert first set is equal to the second set.
     """
     return Polyhedron([left - right], [])
 
 @_polymorphic
 def Ne(left, right):
     """
-    Return true if the sets are NOT equal.
+    Assert first set is not equal to the second set.
     """
     return ~Eq(left, right)
 
 @_polymorphic
 def Gt(left, right):
     """
-    Return true if the first set is greater than the second set.
+    Assert first set is greater than the second set.
     """
     return Polyhedron([], [left - right - 1])
 
 @_polymorphic
 def Ge(left, right):
     """
-    Return true if the first set is greater than or equal the second set.
+    Assert first set is greater than or equal to the second set.
     """
     return Polyhedron([], [left - right])
+