Added some docs

[linpy.git] / doc / polyhedra.rst

diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst
new file mode 100644 (file)
index 0000000..fd09b90
--- /dev/null
+++ b/doc/polyhedra.rst
@@ -0,0 +1,61 @@
+Polyhedra Module
+================
+
+.. py:class:: Polyhedron
+
+Polyhedra Properties
+--------------------
+
+    .. py:method:: equalities(self)
+    
+        Return a list of the equalities in a set.
+        
+    .. py:method:: inequalities(self)
+    
+        Return a list of the inequalities in a set.
+
+    .. py:method:: constraints(self)
+    
+        Return ta list of the constraints of a set.
+
+Unary Operations
+----------------
+    .. py:method:: disjoint(self)
+    
+        Returns this set as a disjoint set.
+               
+    .. py:method:: isuniverse(self)
+    
+        Return true if this set is the Universe set.    
+
+    .. py:method:: aspolyhedron(self)
+    
+        Return polyhedral hull of this set.
+
+    .. py:method:: subs(self, symbol, expression=None)
+    
+        Subsitute expression into given set and returns the result.      
+        
+    .. py:method:: Lt(left, right)
+    
+        Assert first set is less than the second set.     
+        
+    .. py:method:: Le(left, right)
+    
+        Assert first set is less than or equal to the second set.
+        
+    .. py:method:: Eq(left, right)
+    
+        Assert first set is equal to the second set.         
+        
+    .. py:method:: Ne(left, right)
+    
+        Assert first set is not equal to the second set.          
+        
+    .. py:method:: Gt(left, right)
+    
+        Assert first set is greater than the second set.        
+
+    .. py:method:: Ge(left, right)
+    
+        Assert first set is greater than or equal to the second set.