Added some docs
[linpy.git] / doc / polyhedra.rst
1 Polyhedra Module
2 ================
3
4 .. py:class:: Polyhedron
5
6 Polyhedra Properties
7 --------------------
8
9 .. py:method:: equalities(self)
10
11 Return a list of the equalities in a set.
12
13 .. py:method:: inequalities(self)
14
15 Return a list of the inequalities in a set.
16
17 .. py:method:: constraints(self)
18
19 Return ta list of the constraints of a set.
20
21 Unary Operations
22 ----------------
23 .. py:method:: disjoint(self)
24
25 Returns this set as a disjoint set.
26
27 .. py:method:: isuniverse(self)
28
29 Return true if this set is the Universe set.
30
31 .. py:method:: aspolyhedron(self)
32
33 Return polyhedral hull of this set.
34
35 .. py:method:: subs(self, symbol, expression=None)
36
37 Subsitute expression into given set and returns the result.
38
39 .. py:method:: Lt(left, right)
40
41 Assert first set is less than the second set.
42
43 .. py:method:: Le(left, right)
44
45 Assert first set is less than or equal to the second set.
46
47 .. py:method:: Eq(left, right)
48
49 Assert first set is equal to the second set.
50
51 .. py:method:: Ne(left, right)
52
53 Assert first set is not equal to the second set.
54
55 .. py:method:: Gt(left, right)
56
57 Assert first set is greater than the second set.
58
59 .. py:method:: Ge(left, right)
60
61 Assert first set is greater than or equal to the second set.