X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/49fa0d574a20817712006d479549dd96ccfff652..75b826058dcbdb53fea2ed5258b59e806b465449:/doc/reference.rst diff --git a/doc/reference.rst b/doc/reference.rst index de5300d..e649227 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -2,6 +2,7 @@ Module Reference ================ + Symbols ------- @@ -227,6 +228,7 @@ They are implemented by the :class:`Rational` class, that inherits from both :cl See the documentation of :class:`fractions.Fraction` for more information and examples. + Polyhedra --------- @@ -278,10 +280,20 @@ This space can be unbounded. The tuple of constraints, i.e., equalities and inequalities. This is semantically equivalent to: ``equalities + inequalities``. + .. method:: convex_union(polyhedron[, ...]) + + Return the convex union of two or more polyhedra. + + .. method:: asinequalities() + + Express the polyhedron using inequalities, given as a list of expressions greater or equal to 0. + .. method:: widen(polyhedron) Compute the *standard widening* of two polyhedra, à la Halbwachs. + In its current implementation, this method is slow and should not be used on large polyhedra. + .. data:: Empty @@ -493,7 +505,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, ...]) @@ -505,14 +517,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. @@ -677,7 +689,7 @@ Geometric Objects .. method:: cross(vector) Compute the cross product of two 3D vectors. - If either one of the vectors is not tridimensional, a :exc:`ValueError` exception is raised. + If either one of the vectors is not three-dimensional, a :exc:`ValueError` exception is raised. .. method:: dot(vector)