X-Git-Url: https://svn.cri.ensmp.fr/git/linpy.git/blobdiff_plain/b4f536e238161d59db61f4bb5fc6e87d4b7baffe..b676f2dfbaa1aac981210c603bb6407d357a0340:/doc/reference.rst diff --git a/doc/reference.rst b/doc/reference.rst index 5c8da90..64c37c6 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -1,4 +1,6 @@ +.. _reference: + Module Reference ================ @@ -173,7 +175,6 @@ For example, if ``x`` is a :class:`Symbol`, then ``x + 1`` is an instance of :cl >>> x < y Le(x - y + 1, 0) - .. method:: scaleint() Return the expression multiplied by its lowest common denominator to make all values integer. @@ -303,11 +304,12 @@ This space can be unbounded. The universe polyhedron, whose set of constraints is always satisfiable, i.e. is empty. + Domains ------- A *domain* is a union of polyhedra. -Unlike polyhedra, domains allow exact computation of union and complementary operations. +Unlike polyhedra, domains allow exact computation of union, subtraction and complementary operations. .. class:: Domain(*polyhedra) Domain(string) @@ -505,7 +507,7 @@ The following functions create :class:`Polyhedron` or :class:`Domain` instances .. function:: Ne(expr1, expr2[, expr3, ...]) Create the domain such that ``expr1 != expr2 != expr3 ...``. - The result is a :class:`Domain`, not a :class:`Polyhedron`. + The result is a :class:`Domain` object, not a :class:`Polyhedron`. .. function:: Ge(expr1, expr2[, expr3, ...]) @@ -517,14 +519,14 @@ The following functions create :class:`Polyhedron` or :class:`Domain` instances The following functions combine :class:`Polyhedron` or :class:`Domain` instances using logic operators: -.. function:: Or(domain1, domain2[, ...]) - - Create the union domain of the domains given in arguments. - .. function:: And(domain1, domain2[, ...]) Create the intersection domain of the domains given in arguments. +.. function:: Or(domain1, domain2[, ...]) + + Create the union domain of the domains given in arguments. + .. function:: Not(domain) Create the complementary domain of the domain given in argument.