Need to merge
[linpy.git] / doc / linexpr.rst
1 Linear Expression Module
2 ========================
3
4 This class implements linear expressions.
5
6 .. py:method:: coefficient(self, symbol)
7
8 Return the coefficient value of the given symbol.
9
10 .. py:method:: coefficients(self)
11
12 Return a list of the coefficients of an expression
13
14 .. py:method:: constant(self)
15
16 Return the constant value of an expression.
17
18 .. py:method:: symbols(self)
19
20 Return a list of symbols in an expression.
21
22 .. py:method:: dimension(self)
23
24 Return the number of vriables in an expression.
25
26 .. py:method:: __sub__(self, other)
27
28 Return the difference between two expressions.
29
30 .. py:method:: subs(self, symbol, expression=None)
31
32 Subsitute the given value into an expression and return the resulting expression.
33
34 .. py:method:: fromsympy(self)
35
36 Convert sympy object to an expression.
37
38 .. py:method:: tosympy(self)
39
40 Return an expression as a sympy object.
41
42 .. py:class:: Dummy(Symbol)
43
44 This class returns a dummy symbol to ensure that each no variables are repeated in an expression