e45b0fb4ff19d9237cb7c691d5aa6f6daee2d622
1 Domains Module
2 ==============
4 .. py:class :: Domain
6 The properties of a domain can be are found using the following
8 .. py:method:: symbols
10 Returns a tuple of the symbols that exsist in a domain.
12 .. py:method:: dimension
14 Returns the number of variables that exist in a domain.
16 .. py:method:: disjoint
18 Returns a domain as disjoint.
20 .. py:method:: involves_vars(self, vars)
22 Returns ``True`` if a domain depends on the given variables.
25 The unary properties of a domain can be inspected using the following methods.
27 .. py:method:: isempty(self)
29 Return ``True`` is a domain is empty.
31 .. py:method:: isuniverse(self)
33 Return ``True`` if a domain is the Universe set.
35 .. py:method:: isbounded(self)
37 Return ``True`` if a domain is bounded.
39 .. py:method:: disjoint(self)
41 It is not guarenteed that a domain is disjoint. If it is necessary, this method will return a domain as disjoint.
43 The following methods compare two domains to find the binary properties.
45 .. py:method:: isdisjoint(self, other)
47 Return ``True`` if the intersection of *self* and *other* results in an empty set.
49 .. py:method:: issubset(self, other)
51 Test whether every element in a domain is in *other*.
53 .. py:method:: __eq__(self, other)
54 self == other
56 Test whether a domain is equal to *other*.
58 .. py:method:: __lt__(self, other)
59 self < other
61 Test whether a domain is a strict subset of *other*.
63 .. py:method:: __le__(self, other)
64 self <= other
66 Test whether every element in a domain is in *other*.
68 .. py:method:: __gt__(self, other)
69 self > other
71 Test whether a domain is a strict superset of *other*.
73 .. py:method:: __ge__(self, other)
74 self >= other
76 Test whether every element in *other* is in a domain.
79 The following methods implement unary operations on a domain.
81 .. py:method:: complement(self)
82 ¬self
84 Return the complement of a domain.
86 .. py:method:: simplify(self)
88 Return a new domain without any redundant constraints.
90 .. py:method:: project(self, dims)
92 Return a new domain with the given dimensions removed.
94 .. py:method:: aspolyhedron(self)
96 Return polyhedral hull of a domain.
98 .. py:method:: sample(self)
100 Return a single sample subset of a domain.
102 The following methods implement binary operations on two domains.
104 .. py:method:: intersection(self, other)
105 self | other
107 Return a new domain with the elements that are common between *self* and *other*.
109 .. py:method:: union(self, other)
110 self & other
112 Return a new domain with all the elements from *self* and *other*.
114 .. py:method:: difference(self, other)
115 self - other
117 Return a new domain with the elements in a domain that are not in *other* .
120 self + other
122 Return the sum of two domains.
124 The following methods use lexicographical ordering to find the maximum or minimum element in a domain.
126 .. py:method:: lexmin(self)
128 Return a new set containing the lexicographic minimum of the elements in the set.
130 .. py:method:: lexmax(self)
132 Return a new set containing the lexicographic maximum of the elements in the set.
135 A 2D or 3D domain can be plotted using the :meth:`plot` function. The points, verticies, and faces of a domain can be inspected using the following functions.
137 .. py:method:: points(self)
139 Return a list of the points contained in a domain as :class:`Points` objects.
141 .. py:method:: vertices(self)
143 Return a list of the verticies of a domain.
145 .. py:method:: faces(self)
147 Return a list of the vertices for each face of a domain.
149 .. py:method:: plot(self, plot=None, **kwargs)
151 Return a plot of the given domain.