X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/25ce908cffca380f930182a77c1e5a4491042a1c..0f40fdb54d0fc6505342d008deaa1e9c4c9dbcee:/doc/polyhedra.rst diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst index fd09b90..1cb9396 100644 --- a/doc/polyhedra.rst +++ b/doc/polyhedra.rst @@ -1,61 +1,56 @@ Polyhedra Module ================ +Polyhedron class allows users to build and inspect polyherons. + .. py:class:: Polyhedron -Polyhedra Properties --------------------- + .. attribute:: equalities(self) + + Return a list of the equalities in a polyhedron. + + .. attribute:: inequalities(self) - .. 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. + Return a list of the inequalities in a polyhedron. .. py:method:: constraints(self) - - Return ta list of the constraints of a set. -Unary Operations ----------------- + Return ta list of the constraints of 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. - - .. 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. + + Subsitutes an expression into a polyhedron and returns the result. + +To create a polyhedron, the user can use the following functions to define equalities and inequalities as the contraints. + +.. py:function:: Eq(left, right) + + Create a constraint by setting *left* equal to *right*. + +.. py:function:: Ne(left, right) + + Create a constraint by setting *left* not equal to *right*. + +.. py:function:: Lt(left, right) + + Create a constraint by setting *left* less than *right*. + +.. py:function:: Le(left, right) + + Create a constraint by setting *left* less than or equal to *right*. + +.. py:function:: Gt(left, right) + + Create a constraint by setting *left* greater than *right*. + +.. py:function:: Ge(left, right) + + Create a constraint by setting *left* greater than or equal to *right*.