Add license to examples

[linpy.git] / doc / polyhedra.rst

diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst
index 605dded..f6f1a30 100644 (file)
--- a/doc/polyhedra.rst
+++ b/doc/polyhedra.rst
@@ -1,56 +1,74 @@
 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:method::  __new__(cls, equalities=None, inequalities=None)

     
     

-    .. py:property:: equalities(self)
+        Create and return a new Polyhedron from a string or list of equalities and inequalities.
+
+    .. attribute:: equalities

 
 

-        Return a list of the equalities in a polyhedron.
+        Returns a list of the equalities in a polyhedron.

 
 

-    .. py:method:: inequalities(self)
+    .. attribute:: inequalities

 
 

-        Return a list of the inequalities in a polyhedron.
+        Returns a list of the inequalities in a polyhedron.

 
 

-    .. py:method:: constraints(self)
+    .. attribute:: constraints

 
 

-        Return ta 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)
 

-        Subsitutes 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 contraints.
+To create a polyhedron, the user can use the following functions to define  equalities and inequalities as the constraints.

 
 .. py:function:: Eq(left, right)
 
 
 .. py:function:: Eq(left, right)
 

-   Create a constraint by setting *left* equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* equal to *right*.

 
 .. py:function:: Ne(left, right)
 
 
 .. py:function:: Ne(left, right)
 

-    Create a constraint by setting *left* not equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* not equal to *right*.

 
 .. py:function:: Lt(left, right)
 
 
 .. py:function:: Lt(left, right)
 

-   Create a constraint by setting *left* less than *right*.
+   Returns a Polyhedron instance with a single constraint as *left* less than *right*.

 
 .. py:function:: Le(left, right)
 
 
 .. py:function:: Le(left, right)
 

-   Create a constraint by setting *left* less than or equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* less than or equal to *right*.

 
 .. py:function:: Gt(left, right)
 
 
 .. py:function:: Gt(left, right)
 

-   Create a constraint by setting *left* greater than *right*.
+   Returns a Polyhedron instance with a single constraint as *left* greater than *right*.

 
 .. py:function:: Ge(left, right)
 
 
 .. py:function:: Ge(left, right)
 

-   Create a constraint by setting *left* greater than or equal to *right*.
+   Returns a Polyhedron instance with a single constraint as *left* greater than or equal to *right*.