X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/25ce908cffca380f930182a77c1e5a4491042a1c..5eca735504be3b7c301e2a1fa37712eb88b4ec64:/doc/polyhedra.rst diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst index fd09b90..de0dfd5 100644 --- a/doc/polyhedra.rst +++ b/doc/polyhedra.rst @@ -3,59 +3,56 @@ Polyhedra Module .. py:class:: Polyhedron -Polyhedra Properties --------------------- + Polyhedron class allows users to build and inspect polyherons. The following methods provide the properties of a polyhedron. .. py:method:: equalities(self) - Return a list of the equalities in a set. + Return a list of the equalities in a polyhedron. .. py:method:: inequalities(self) - Return a list of the inequalities in a set. + Return a list of the inequalities in a polyhedron. .. py:method:: constraints(self) - Return ta list of the constraints of a set. + Return ta list of the constraints of a polyhedron. -Unary Operations ----------------- + The following unary operations can be used to inspect a polyhedron. + .. py:method:: disjoint(self) - Returns this set as a disjoint set. + Returns a polyhedron as a disjoint. .. py:method:: isuniverse(self) - Return true if this set is the Universe set. - - .. py:method:: aspolyhedron(self) - - Return polyhedral hull of this set. + Return ``True`` if a polyhedron is the Universe 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. + Subsitutes an expression into a polyhedron and returns the result. + +To create a polyhedron, the user must use the folloing functions to define equalities and inequalities as the contraints. + +.. py:function:: Eq(left, right) + + Create a constraint by setting *left* equal to *right*. - .. py:method:: Eq(left, right) +.. py:function:: Ne(left, right) + + Create a constraint by setting *left* not equal to *right*. + +.. py:function:: Lt(left, right) - Assert first set is equal to the second set. + Create a constraint by setting *left* less than *right*. - .. py:method:: Ne(left, right) +.. py:function:: Le(left, right) - Assert first set is not equal to the second set. + Create a constraint by setting *left* less than or equal to *right*. - .. py:method:: Gt(left, right) +.. py:function:: Gt(left, right) - Assert first set is greater than the second set. + Create a constraint by setting *left* greater than *right*. - .. py:method:: Ge(left, right) +.. py:function:: Ge(left, right) - Assert first set is greater than or equal to the second set. + Create a constraint by setting *left* greater than or equal to *right*.