X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/98936866ae400d45b7b74f7ba0d04c66ace0424f..5eca735504be3b7c301e2a1fa37712eb88b4ec64:/doc/domain.rst diff --git a/doc/domain.rst b/doc/domain.rst index 91b96f8..e45b0fb 100644 --- a/doc/domain.rst +++ b/doc/domain.rst @@ -3,12 +3,8 @@ Domains Module .. py:class :: Domain - .. py:method:: polyhedra(self) - - Return . - -Domain Properties ------------------ + 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. @@ -21,16 +17,13 @@ Domain Properties Returns a domain as disjoint. - .. py:method:: num_parameters + .. py:method:: involves_vars(self, vars) + + Returns ``True`` if a domain depends on the given variables. - Returns the total number of parameters, input, output or dimensions in a domain. - .. py:method:: involves_dims(self, dims) + The unary properties of a domain can be inspected using the following methods. - Returns ``True`` if a domain depends on the given dimensions. - -Unary Properties ----------------- .. py:method:: isempty(self) Return ``True`` is a domain is empty. @@ -41,14 +34,13 @@ Unary Properties .. py:method:: isbounded(self) - Return ``True`` if a domain is bounded + Return ``True`` if a domain is bounded. .. py:method:: disjoint(self) - Returns a domain as disjoint. + It is not guarenteed that a domain is disjoint. If it is necessary, this method will return a domain as disjoint. -Binary Properties ------------------ + The following methods compare two domains to find the binary properties. .. py:method:: isdisjoint(self, other) @@ -144,7 +136,7 @@ Binary Properties .. py:method:: points(self) - Return a list of the points contained in a domain. + Return a list of the points contained in a domain as :class:`Points` objects. .. py:method:: vertices(self)