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