X-Git-Url: https://scm.cri.mines-paristech.fr/git/linpy.git/blobdiff_plain/98936866ae400d45b7b74f7ba0d04c66ace0424f..50f0fde4dca3f10e535314b1c9d325cd9283735b:/doc/linexpr.rst diff --git a/doc/linexpr.rst b/doc/linexpr.rst index 4101252..b5d8069 100644 --- a/doc/linexpr.rst +++ b/doc/linexpr.rst @@ -1,7 +1,10 @@ Linear Expression Module ======================== -This class implements linear expressions. +This class implements linear expressions. A linear expression is…. + +.. py:class:: Expression + .. py:method:: coefficient(self, symbol) @@ -11,21 +14,21 @@ This class implements linear expressions. Return a list of the coefficients of an expression - .. py:method:: constant(self) + .. attribute:: constant Return the constant value of an expression. - .. py:method:: symbols(self) + .. attribute:: symbols Return a list of symbols in an expression. - .. py:method:: dimension(self) + .. attribute:: dimension - Return the number of vriables in an expression. + Return the number of variables in an expression. .. py:method:: __sub__(self, other) - Return the difference between two expressions. + Return the difference between *self* and *other*. .. py:method:: subs(self, symbol, expression=None) @@ -38,6 +41,9 @@ This class implements linear expressions. .. py:method:: tosympy(self) Return an expression as a sympy object. + +.. py:class:: Symbol(Expression) + .. py:class:: Dummy(Symbol)