doc/polyhedra.rst

   1 Polyhedra Module
   2 ================
   3
   4 Polyhedron class allows users to build and inspect polyherons.
   5
   6 .. py:class:: Polyhedron
   7
   8     .. py:property:: equalities
   9
  10         Returns a list of the equalities in a polyhedron.
  11
  12     .. py:property:: inequalities
  13
  14         Returns a list of the inequalities in a polyhedron.
  15
  16     .. py:property:: constraints
  17
  18         Returns a list of the constraints of a polyhedron.
  19
  20     .. py:method:: disjoint(self)
  21
  22         Returns a polyhedron as a disjoint.
  23
  24     .. py:method:: isuniverse(self)
  25
  26         Return ``True`` if a polyhedron is the Universe set.
  27
  28     .. py:method:: subs(self, symbol, expression=None)
  29
  30         Substitutes an expression into a polyhedron and returns the result.
  31
  32 To create a polyhedron, the user can use the following functions to define  equalities and inequalities as the constraints.
  33
  34 .. py:function:: Eq(left, right)
  35
  36    Returns a Polyhedron instance with a single constraint as *left* equal to *right*.
  37
  38 .. py:function:: Ne(left, right)
  39
  40    Returns a Polyhedron instance with a single constraint as *left* not equal to *right*.
  41
  42 .. py:function:: Lt(left, right)
  43
  44    Returns a Polyhedron instance with a single constraint as *left* less than *right*.
  45
  46 .. py:function:: Le(left, right)
  47
  48    Returns a Polyhedron instance with a single constraint as *left* less than or equal to *right*.
  49
  50 .. py:function:: Gt(left, right)
  51
  52    Returns a Polyhedron instance with a single constraint as *left* greater than *right*.
  53
  54 .. py:function:: Ge(left, right)
  55
  56    Returns a Polyhedron instance with a single constraint as *left* greater than or equal to *right*.