779be4654cd827739dc9c16b3071f4011de15247
[linpy.git] / doc / polyhedra.rst
1 Polyhedra Module
2 ================
3
4 .. py:class:: Polyhedron
5
6 Polyhedron class allows users to build and inspect polyherons. The following methods provide the properties of a polyhedron.
7
8 .. py:method:: equalities(self)
9
10 Return a list of the equalities in a polyhedron.
11
12 .. py:method:: inequalities(self)
13
14 Return a list of the inequalities in a polyhedron.
15
16 .. py:method:: constraints(self)
17
18 Return ta list of the constraints of a polyhedron.
19
20 The following unary operations can be used to inspect a polyhedron.
21
22 .. py:method:: disjoint(self)
23
24 Returns a polyhedron as a disjoint.
25
26 .. py:method:: isuniverse(self)
27
28 Return ``True`` if a polyhedron is the Universe set.
29
30 .. py:method:: subs(self, symbol, expression=None)
31
32 Subsitutes an expression into a polyhedron and returns the result.
33
34 To create a polyhedron, the user must use the folloing functions to define the equalities and inequalities which are the contraints of a polyhedron.
35
36 .. py:function:: Eq(left, right)
37
38 Create a constraint by setting *left* equal to *right*.
39
40 .. py:function:: Ne(left, right)
41
42 Create a constraint by setting *left* not equal to *right*.
43
44 .. py:function:: Lt(left, right)
45
46 Create a constraint by setting *left* less than *right*.
47
48 .. py:function:: Le(left, right)
49
50 Create a constraint by setting *left* less than or equal to *right*.
51
52 .. py:function:: Gt(left, right)
53
54 Create a constraint by setting *left* greater than *right*.
55
56 .. py:function:: Ge(left, right)
57
58 Create a constraint by setting *left* greater than or equal to *right*.