.. py:class :: Domain
- .. py:method:: polyhedra(self)
-
- Return .
-
-Domain Properties
------------------
- .. py:method:: symbols(self)
-
- Returns a list of the symbols used in a set.
-
- .. py:method:: dimension(self)
-
- Returns the number of variables in a set.
+ The properties of a domain can be are found using the following
+
+ .. py:method:: symbols
+
+ Returns a tuple of the symbols that exsist in a domain.
+
+ .. py:method:: dimension
+
+ Returns the number of variables that exist in a domain.
+
+ .. py:method:: disjoint
+
+ Returns a domain as disjoint.
+
+ .. py:method:: involves_vars(self, dims)
+
+ Returns ``True`` if a domain depends on the given dimensions.
+
+ The unary properties of a domain can be inspected using the following methods.
- .. py:method:: disjoint(self)
-
- Returns a set as disjoint.
-
- .. py:method:: num_parameters(self)
-
- Returns the total number of parameters, input, output or set dimensions.
-
- .. py:method:: involves_dims(self, dims)
-
- Returns true if set depends on given dimensions.
-
-Unary Properties
-----------------
.. py:method:: isempty(self)
-
- Return true is set is an Empty set.
-
+
+ Return ``True`` is a domain is empty.
+
.. py:method:: isuniverse(self)
-
- Return true if set is the Universe set.
-
+
+ Return ``True`` if a domain is the Universe set.
+
.. py:method:: isbounded(self)
-
- Return true if set is bounded
+
+ Return ``True`` if a domain is bounded.
.. py:method:: disjoint(self)
-
- Returns this set as a disjoint set.
-Binary Properties
------------------
+ It is not guarenteed that a domain is disjoint. If it is necessary, this method will return a domain as disjoint.
+
+ The following methods compare two domains to find the binary properties.
.. py:method:: isdisjoint(self, other)
-
- Return true if the intersection of two sets results in an Empty set.
-
+
+ Return ``True`` if the intersection of *self* and *other* results in an empty set.
+
.. py:method:: issubset(self, other)
-
- Returns true if one set contains the other set.
+
+ Test whether every element in a domain is in *other*.
.. py:method:: __eq__(self, other)
-
- Return true if self == other.
-
+ self == other
+
+ Test whether a domain is equal to *other*.
+
.. py:method:: __lt__(self, other)
-
- Return true if self < other.
-
+ self < other
+
+ Test whether a domain is a strict subset of *other*.
+
.. py:method:: __le__(self, other)
-
- Return true if self <= other.
-
+ self <= other
+
+ Test whether every element in a domain is in *other*.
+
.. py:method:: __gt__(self, other)
-
- Return true if self > other.
-
+ self > other
+
+ Test whether a domain is a strict superset of *other*.
+
.. py:method:: __ge__(self, other)
-
- Return true if self >= other.
-
+ self >= other
+
+ Test whether every element in *other* is in a domain.
-Unary Operations
-----------------
+
+ The following methods implement unary operations on a domain.
.. py:method:: complement(self)
-
- Return the complement of a set.
-
+ ¬self
+
+ Return the complement of a domain.
+
.. py:method:: simplify(self)
- Removes redundant constraints from a set.
+ Return a new domain without any redundant constraints.
.. py:method:: project(self, dims)
-
- Return a new set with the given dimensions removed.
+
+ Return a new domain with the given dimensions removed.
.. py:method:: aspolyhedron(self)
-
- Return polyhedral hull of a set.
-
- .. py:method:: asdomain(self)
-
- Return
+
+ Return polyhedral hull of a domain.
.. py:method:: sample(self)
-
- Return a single sample subset of a set.
-
-Binary Operations
------------------
-
- .. py:method:: intersection(self)
-
- Return the intersection of two sets as a new set.
-
- .. py:method:: union(self)
-
- Return the union of two sets as a new set.
-
- .. py:method:: __and__(self, other)
-
- Return the union of two sets as a new set.
-
- .. py:method:: __or__(self, other)
-
- Return the intersection of two sets as a new set.
-
- .. py:method:: __add__(self, other)
-
- Return the sum of two sets.
+
+ Return a single sample subset of a domain.
+
+ The following methods implement binary operations on two domains.
+
+ .. py:method:: intersection(self, other)
+ self | other
+
+ Return a new domain with the elements that are common between *self* and *other*.
+
+ .. py:method:: union(self, other)
+ self & other
+
+ Return a new domain with all the elements from *self* and *other*.
.. py:method:: difference(self, other)
-
- Return the difference of two sets.
+ self - other
+
+ Return a new domain with the elements in a domain that are not in *other* .
-Lexiographic Operations
------------------------
+ .. py:method:: __add__(self, other)
+ self + other
+
+ Return the sum of two domains.
+
+ The following methods use lexicographical ordering to find the maximum or minimum element in a domain.
.. py:method:: lexmin(self)
-
- Return a new set containing the lexicographic minimum of the elements in the set.
-
+
+ Return a new set containing the lexicographic minimum of the elements in the set.
+
.. py:method:: lexmax(self)
-
- Return a new set containing the lexicographic maximum of the elements in the set.
-
-Plot Properties
----------------
+
+ Return a new set containing the lexicographic maximum of the elements in the set.
+
+
+ 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.
.. py:method:: points(self)
-
- Return a list of the points contained in a set.
+
+ Return a list of the points contained in a domain as :class:`Points` objects.
.. py:method:: vertices(self)
-
- Return a list of the verticies of this set.
-
+
+ Return a list of the verticies of a domain.
+
.. py:method:: faces(self)
-
- Return a list of the vertices for each face of a set.
-
+
+ Return a list of the vertices for each face of a domain.
+
.. py:method:: plot(self, plot=None, **kwargs)
-
- Return a plot of the given set.
-
-
-
+
+ Return a plot of the given domain.
projects / linpy.git / blobdiff