X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/960f0c252361dfd696359f803aae40a9b13b14a6..50f0fde4dca3f10e535314b1c9d325cd9283735b:/doc/domain.rst diff --git a/doc/domain.rst b/doc/domain.rst index 4cd79d9..b85b2d0 100644 --- a/doc/domain.rst +++ b/doc/domain.rst @@ -3,26 +3,14 @@ Domains Module .. py:class :: Domain - The properties of a domain can be are found using the following - - .. py:method:: symbols + .. attribute:: symbols Returns a tuple of the symbols that exsist in a domain. - .. py:method:: dimension + .. attribute:: 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:: isempty(self) Return ``True`` is a domain is empty. @@ -39,8 +27,6 @@ Domains Module 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 *self* and *other* results in an empty set. @@ -74,11 +60,8 @@ Domains Module Test whether every element in *other* is in a domain. - - The following methods implement unary operations on a domain. - .. py:method:: complement(self) - ¬self + ~self Return the complement of a domain. @@ -86,9 +69,9 @@ Domains Module Return a new domain without any redundant constraints. - .. py:method:: project(self, dims) + .. py:method:: project(self, variables) - Return a new domain with the given dimensions removed. + Return a new domain with the given variables removed. .. py:method:: aspolyhedron(self) @@ -98,19 +81,20 @@ Domains Module Return a single sample subset of a domain. - The following methods implement binary operations on two domains. - .. py:method:: intersection(self, other) + __or__ self | other Return a new domain with the elements that are common between *self* and *other*. .. py:method:: union(self, other) + __and__ self & other Return a new domain with all the elements from *self* and *other*. .. py:method:: difference(self, other) + __sub__ self - other Return a new domain with the elements in a domain that are not in *other* . @@ -120,8 +104,6 @@ Domains Module 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. @@ -131,7 +113,7 @@ Domains Module 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. +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. .. py:method:: points(self) @@ -147,4 +129,4 @@ Domains Module .. py:method:: plot(self, plot=None, **kwargs) - Return a plot of the given domain. + Return a plot of the given domain or add a plot to a plot instance.