X-Git-Url: https://scm.cri.ensmp.fr/git/linpy.git/blobdiff_plain/dbe638f61f1927ee6f3dffaaf2dc34418725f50a..1551132d8878c3cec4609ec9b47cb30f72df5350:/doc/reference.rst diff --git a/doc/reference.rst b/doc/reference.rst index 8e36056..ae82aca 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -1,8 +1,12 @@ +.. _reference: + Module Reference ================ +.. _reference_symbols: + Symbols ------- @@ -68,6 +72,8 @@ This is achieved using ``Dummy('x')``. True +.. _reference_linexprs: + Linear Expressions ------------------ @@ -228,6 +234,8 @@ 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. +.. _reference_polyhedra: + Polyhedra --------- @@ -303,11 +311,13 @@ This space can be unbounded. The universe polyhedron, whose set of constraints is always satisfiable, i.e. is empty. +.. _reference_domains: + 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) @@ -485,6 +495,8 @@ Unlike polyhedra, domains allow exact computation of union and complementary ope Convert the domain to a sympy expression. +.. _reference_operators: + Comparison and Logic Operators ------------------------------ @@ -530,6 +542,8 @@ The following functions combine :class:`Polyhedron` or :class:`Domain` instances Create the complementary domain of the domain given in argument. +.. _reference_geometry: + Geometric Objects -----------------