X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/9b755b94aa2c8847ffca607de239f5c3bca9984b..960f0c252361dfd696359f803aae40a9b13b14a6:/doc/polyhedra.rst diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst index de0dfd5..736cff6 100644 --- a/doc/polyhedra.rst +++ b/doc/polyhedra.rst @@ -3,56 +3,56 @@ Polyhedra Module .. py:class:: Polyhedron - Polyhedron class allows users to build and inspect polyherons. The following methods provide the properties of a polyhedron. + 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 polyhedron. - + .. py:method:: inequalities(self) - + Return a list of the inequalities in a polyhedron. .. py:method:: constraints(self) - + Return ta list of the constraints of a polyhedron. The following unary operations can be used to inspect a polyhedron. - + .. py:method:: disjoint(self) - + Returns a polyhedron as a disjoint. - + .. py:method:: isuniverse(self) - - Return ``True`` if a polyhedron is the Universe set. + + Return ``True`` if a polyhedron is the Universe set. .. py:method:: subs(self, symbol, expression=None) - - Subsitutes an expression into a polyhedron and returns the result. + + 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*. - + + 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*. - + + 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*. - + + 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*. + + 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*. + + Create a constraint by setting *left* greater than or equal to *right*.