X-Git-Url: https://svn.cri.ensmp.fr/git/linpy.git/blobdiff_plain/960f0c252361dfd696359f803aae40a9b13b14a6..50f0fde4dca3f10e535314b1c9d325cd9283735b:/doc/polyhedra.rst diff --git a/doc/polyhedra.rst b/doc/polyhedra.rst index 736cff6..1f2756b 100644 --- a/doc/polyhedra.rst +++ b/doc/polyhedra.rst @@ -1,23 +1,21 @@ 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. - .. py:method:: equalities(self) +.. py:class:: Polyhedron - Return a list of the equalities in a polyhedron. + .. py:property:: equalities - .. py:method:: inequalities(self) + Returns a list of the equalities in a polyhedron. - Return a list of the inequalities in a polyhedron. + .. py:property:: inequalities - .. py:method:: constraints(self) + Returns a list of the inequalities in a polyhedron. - Return ta list of the constraints of a polyhedron. + .. py:property:: constraints - The following unary operations can be used to inspect a polyhedron. + Returns a list of the constraints of a polyhedron. .. py:method:: disjoint(self) @@ -29,30 +27,30 @@ Polyhedra Module .. py:method:: subs(self, symbol, expression=None) - Subsitutes an expression into a polyhedron and returns the result. + Substitutes 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. +To create a polyhedron, the user can use the following functions to define equalities and inequalities as the constraints. .. 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) - 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) - 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) - 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) - 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) - 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*.