Expression class¶
(Shortest import: from brian2 import Expression)
-
class
brian2.equations.codestrings.
Expression
(code=None, sympy_expression=None)[source]¶ Bases:
brian2.equations.codestrings.CodeString
Class for representing an expression.
- Parameters
code : str, optional
The expression. Note that the expression has to be written in a form that is parseable by sympy. Alternatively, a sympy expression can be provided (in the
sympy_expression
argument).sympy_expression : sympy expression, optional
A sympy expression. Alternatively, a plain string expression can be provided (in the
code
argument).
Attributes
Stochastic variables in this expression
Methods
Split the expression into a stochastic and non-stochastic part.
Details
-
stochastic_variables
¶ Stochastic variables in this expression
-
split_stochastic
()[source]¶ Split the expression into a stochastic and non-stochastic part.
Splits the expression into a tuple of one
Expression
objects f (the non-stochastic part) and a dictionary mapping stochastic variables toExpression
objects. For example, an expression of the formf + g * xi_1 + h * xi_2
would be returned as:(f, {'xi_1': g, 'xi_2': h})
Note that theExpression
objects for the stochastic parts do not include the stochastic variable itself.- Returns
(f, d) : (
Expression
, dict)A tuple of an
Expression
object and a dictionary, the first expression being the non-stochastic part of the equation and the dictionary mapping stochastic variables (xi
or starting withxi_
) toExpression
objects. If no stochastic variable is present in the code string, a tuple(self, None)
will be returned with the unchangedExpression
object.