Add license to examples

[linpy.git] / doc / polyhedra.rst

diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst
index 1f2756b..f6f1a30 100644 (file)
--- a/doc/polyhedra.rst
+++ b/doc/polyhedra.rst
@@ -1,33 +1,51 @@
 Polyhedra Module
 ================
 
 Polyhedra Module
 ================
 

-Polyhedron class allows users to build and inspect polyherons.
+Polyhedron class allows users to build and inspect polyherons. Polyhedron inherits all methods from the :class:`Domain` class.

 
 

-.. py:class:: Polyhedron
+.. py:class:: Polyhedron(Domain)

 
 

-    .. py:property:: equalities
+    .. py:method::  __new__(cls, equalities=None, inequalities=None)
+    
+        Create and return a new Polyhedron from a string or list of equalities and inequalities.
+
+    .. attribute:: equalities

 
         Returns a list of the equalities in a polyhedron.
 
 
         Returns a list of the equalities in a polyhedron.
 

-    .. py:property:: inequalities
+    .. attribute:: inequalities

 
         Returns a list of the inequalities in a polyhedron.
 
 
         Returns a list of the inequalities in a polyhedron.
 

-    .. py:property:: constraints
+    .. attribute:: constraints

 
         Returns a list of the constraints of a polyhedron.
 
 
         Returns a list of the constraints of a polyhedron.
 

-    .. py:method:: disjoint(self)
+    .. py:method:: make_disjoint(self)

 
         Returns a polyhedron as a disjoint.
 
     .. py:method:: isuniverse(self)
 
         Return ``True`` if a polyhedron is the Universe set.
 
         Returns a polyhedron as a disjoint.
 
     .. py:method:: isuniverse(self)
 
         Return ``True`` if a polyhedron is the Universe set.

+        
+    .. py:method:: aspolyhedron(self)
+    
+        Return the polyhedral hull of a polyhedron.    
+
+    .. py:method:: __contains__(self, point)
+
+        Report whether a polyhedron constains an integer point

 
     .. py:method:: subs(self, symbol, expression=None)
 
 
     .. py:method:: subs(self, symbol, expression=None)
 

-        Substitutes an expression into a polyhedron and returns the result.
+        Subsitute the given value into an expression and return the resulting
+        expression.
+
+    .. py:method:: fromstring(cls, string)
+        
+        Create and return a Polyhedron from a string.
+       

 
 To create a polyhedron, the user can use the following functions to define  equalities and inequalities as the constraints.
 
 
 To create a polyhedron, the user can use the following functions to define  equalities and inequalities as the constraints.