X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/98936866ae400d45b7b74f7ba0d04c66ace0424f..dc449ca80b432de202188a4300ef990abeb968a1:/doc/polyhedra.rst~ diff --git a/doc/polyhedra.rst~ b/doc/polyhedra.rst~ deleted file mode 100644 index 67cb251..0000000 --- a/doc/polyhedra.rst~ +++ /dev/null @@ -1,58 +0,0 @@ -Polyhedra Module -================ - -.. py:class:: 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. - - .. py:method:: subs(self, symbol, expression=None) - - Subsitutes an expression into a polyhedron and returns the result. - -To create a polyhedron, the user must use the folloing functions to define the equalities and inequalities which are the contraints of a polyhedron. - -.. py:function:: Lt(left, right) - - Assert first set is less than the second set. - -.. py:function:: Le(left, right) - - Assert first set is less than or equal to the second set. - -.. py:function:: Eq(left, right) - - Assert first set is equal to the second set. - -.. py:function:: Ne(left, right) - - Assert first set is not equal to the second set. - -.. py:function:: Gt(left, right) - - Assert first set is greater than the second set. - -.. py:function:: Ge(left, right) - - Assert first set is greater than or equal to the second set.