Added some docs
[linpy.git] / doc / domain.rst~
1 Domains Module
2 ==============
3
4 .. py:class :: Domain
5
6 .. py:method:: polyhedra(self)
7
8 Return .
9
10 Domain Properties
11 -----------------
12 .. py:method:: symbols(self)
13
14 Returns a list of the symbols used in a set.
15
16 .. py:method:: dimension(self)
17
18 Returns the number of variables in a set.
19
20 .. py:method:: disjoint(self)
21
22 Returns a set as disjoint.
23
24 .. py:method:: num_parameters(self)
25
26 Returns the total number of parameters, input, output or set dimensions.
27
28 .. py:method:: involves_dims(self, dims)
29
30 Returns true if set depends on given dimensions.
31
32 Unary Properties
33 ----------------
34 .. py:method:: isempty(self)
35
36 Return true is set is an Empty set.
37
38 .. py:method:: isuniverse(self)
39
40 Return true if set is the Universe set.
41
42 .. py:method:: isbounded(self)
43
44 Return true if set is bounded
45
46 .. py:method:: disjoint(self)
47
48 Returns this set as a disjoint set.
49
50 Binary Properties
51 -----------------
52
53 .. py:method:: isdisjoint(self, other)
54
55 Return true if the intersection of two sets results in an Empty set.
56
57 .. py:method:: issubset(self, other)
58
59 Returns true if one set contains the other set.
60
61 .. py:method:: __eq__(self, other)
62
63 Return true if self == other.
64
65 .. py:method:: __lt__(self, other)
66
67 Return true if self < other.
68
69 .. py:method:: __le__(self, other)
70
71 Return true if self <= other.
72
73 .. py:method:: __gt__(self, other)
74
75 Return true if self > other.
76
77 .. py:method:: __ge__(self, other)
78
79 Return true if self >= other.
80
81
82 Unary Operations
83 ----------------
84
85 .. py:method:: complement(self)
86
87 Return the complement of a set.
88
89 .. py:method:: simplify(self)
90
91 Removes redundant constraints from a set.
92
93 .. py:method:: project(self, dims)
94
95 Return a new set with the given dimensions removed.
96
97 .. py:method:: aspolyhedron(self)
98
99 Return polyhedral hull of a set.
100
101 .. py:method:: asdomain(self)
102
103 Return
104
105 .. py:method:: sample(self)
106
107 Return a single sample subset of a set.
108
109 Binary Operations
110 -----------------
111
112 .. py:method:: intersection(self)
113
114 Return the intersection of two sets as a new set.
115
116 .. py:method:: union(self)
117
118 Return the union of two sets as a new set.
119
120 .. py:method:: __and__(self, other)
121
122 Return the union of two sets as a new set.
123
124 .. py:method:: __or__(self, other)
125
126 Return the intersection of two sets as a new set.
127
128 .. py:method:: __add__(self, other)
129
130 Return the sum of two sets.
131
132 .. py:method:: difference(self, other)
133
134 Return the difference of two sets.
135
136 Lexiographic Operations
137 -----------------------
138
139 .. py:method:: lexmin(self)
140
141 Return a new set containing the lexicographic minimum of the elements in the set.
142
143 .. py:method:: lexmax(self)
144
145 Return a new set containing the lexicographic maximum of the elements in the set.
146
147 Plot Properties
148 ---------------
149
150 .. py:method:: points(self)
151
152 Return a list of the points contained in a set.
153
154 .. py:method:: vertices(self)
155
156 Return a list of the verticies of this set.
157
158 .. py:method:: faces(self)
159
160 Return a list of the vertices for each face of a set.
161
162 .. py:method:: plot(self, plot=None, **kwargs)
163
164 Return a plot of the given set.
165
166
167