projects
/
linpy.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Fix unitary tests
[linpy.git]
/
doc
/
reference.rst
diff --git
a/doc/reference.rst
b/doc/reference.rst
index
e649227
..
ae82aca
100644
(file)
--- a/
doc/reference.rst
+++ b/
doc/reference.rst
@@
-1,8
+1,12
@@
+.. _reference:
+
Module Reference
================
Module Reference
================
+.. _reference_symbols:
+
Symbols
-------
Symbols
-------
@@
-68,6
+72,8
@@
This is achieved using ``Dummy('x')``.
True
True
+.. _reference_linexprs:
+
Linear Expressions
------------------
Linear Expressions
------------------
@@
-173,7
+179,6
@@
For example, if ``x`` is a :class:`Symbol`, then ``x + 1`` is an instance of :cl
>>> x < y
Le(x - y + 1, 0)
>>> x < y
Le(x - y + 1, 0)
-
.. method:: scaleint()
Return the expression multiplied by its lowest common denominator to make all values integer.
.. method:: scaleint()
Return the expression multiplied by its lowest common denominator to make all values integer.
@@
-229,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.
See the documentation of :class:`fractions.Fraction` for more information and examples.
+.. _reference_polyhedra:
+
Polyhedra
---------
Polyhedra
---------
@@
-303,11
+310,14
@@
This space can be unbounded.
The universe polyhedron, whose set of constraints is always satisfiable, i.e. is empty.
The universe polyhedron, whose set of constraints is always satisfiable, i.e. is empty.
+
+.. _reference_domains:
+
Domains
-------
A *domain* is a union of polyhedra.
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)
.. 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.
Convert the domain to a sympy expression.
+.. _reference_operators:
+
Comparison and Logic 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.
Create the complementary domain of the domain given in argument.
+.. _reference_geometry:
+
Geometric Objects
-----------------
Geometric Objects
-----------------