X-Git-Url: https://svn.cri.ensmp.fr/git/linpy.git/blobdiff_plain/25ce908cffca380f930182a77c1e5a4491042a1c..88b274d96fde76a3fb7f41c7c2359c8dc8987cb8:/doc/linexpr.rst?ds=sidebyside diff --git a/doc/linexpr.rst b/doc/linexpr.rst index 3771d5f..b5d8069 100644 --- a/doc/linexpr.rst +++ b/doc/linexpr.rst @@ -1,8 +1,10 @@ Linear Expression Module ======================== +This class implements linear expressions. A linear expression is…. + +.. py:class:: Expression -This class implements linear expressions. .. py:method:: coefficient(self, symbol) @@ -12,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) @@ -39,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)