1 Domains Module
2 ==============
4 .. py:class :: Domain
6 .. attribute:: symbols
8 Returns a tuple of the symbols that exsist in a domain.
10 .. attribute:: dimension
12 Returns the number of variables that exist in a domain.
14 .. py:method:: isempty(self)
16 Return ``True`` is a domain is empty.
18 .. py:method:: isuniverse(self)
20 Return ``True`` if a domain is the Universe set.
22 .. py:method:: isbounded(self)
24 Return ``True`` if a domain is bounded.
26 .. py:method:: disjoint(self)
28 It is not guarenteed that a domain is disjoint. If it is necessary, this method will return a domain as disjoint.
30 .. py:method:: isdisjoint(self, other)
32 Return ``True`` if the intersection of *self* and *other* results in an empty set.
34 .. py:method:: issubset(self, other)
36 Test whether every element in a domain is in *other*.
38 .. py:method:: __eq__(self, other)
39 self == other
41 Test whether a domain is equal to *other*.
43 .. py:method:: __lt__(self, other)
44 self < other
46 Test whether a domain is a strict subset of *other*.
48 .. py:method:: __le__(self, other)
49 self <= other
51 Test whether every element in a domain is in *other*.
53 .. py:method:: __gt__(self, other)
54 self > other
56 Test whether a domain is a strict superset of *other*.
58 .. py:method:: __ge__(self, other)
59 self >= other
61 Test whether every element in *other* is in a domain.
63 .. py:method:: complement(self)
64 ~self
66 Return the complement of a domain.
68 .. py:method:: simplify(self)
70 Return a new domain without any redundant constraints.
72 .. py:method:: project(self, variables)
74 Return a new domain with the given variables removed.
76 .. py:method:: aspolyhedron(self)
78 Return polyhedral hull of a domain.
80 .. py:method:: sample(self)
82 Return a single sample subset of a domain.
84 .. py:method:: intersection(self, other)
85 __or__
86 self | other
88 Return a new domain with the elements that are common between *self* and *other*.
90 .. py:method:: union(self, other)
91 __and__
92 self & other
94 Return a new domain with all the elements from *self* and *other*.
96 .. py:method:: difference(self, other)
97 __sub__
98 self - other
100 Return a new domain with the elements in a domain that are not in *other* .
103 self + other
105 Return the sum of two domains.
107 .. py:method:: lexmin(self)
109 Return a new set containing the lexicographic minimum of the elements in the set.
111 .. py:method:: lexmax(self)
113 Return a new set containing the lexicographic maximum of the elements in the set.
116 A 2D or 3D domain can be plotted using the :meth:`plot` method. The points, vertices, and faces of a domain can be inspected using the following functions.
118 .. py:method:: points(self)
120 Return a list of the points contained in a domain as :class:`Points` objects.
122 .. py:method:: vertices(self)
124 Return a list of the verticies of a domain.
126 .. py:method:: faces(self)
128 Return a list of the vertices for each face of a domain.
130 .. py:method:: plot(self, plot=None, **kwargs)
132 Return a plot of the given domain or add a plot to a plot instance.