nektar._ewriter.NektarExpressionWriter Class Reference

Inheritance diagram for nektar._ewriter.NektarExpressionWriter:

Public Member Functions
	__init__ (self)
	set_condition_function (self, func=None)

Protected Member Functions
	_ex_quotient (self, e)
	_ex_remainder (self, e)
	_ex_power (self, e)
	_ex_log (self, e)
	_ex_abs (self, e)
	_ex_not (self, e)
	_ex_and (self, e)
	_ex_or (self, e)
	_ex_if (self, e)
	_ex_piecewise (self, e)

Protected Attributes
	_function_prefix
	_fcond

Detailed Description

This :class:`ExpressionWriter <myokit.formats.ExpressionWriter>` writes
equations for variables in a Nektar-style syntax.

Definition at line 14 of file _ewriter.py.

Constructor & Destructor Documentation

__init__()

nektar._ewriter.NektarExpressionWriter.__init__

(

self

)

Definition at line 19 of file _ewriter.py.

    def __init__(self):
        super(NektarExpressionWriter, self).__init__()
        self._function_prefix = ''
        self._fcond = None
 

References nektar._ewriter.NektarExpressionWriter.__init__().

Referenced by nektar._ewriter.NektarExpressionWriter.__init__().

Member Function Documentation

_ex_abs()

nektar._ewriter.NektarExpressionWriter._ex_abs (   self,   e  )

protected

Definition at line 78 of file _ewriter.py.

    def _ex_abs(self, e):
        return self._ex_function(e, 'fabs')
 

_ex_and()

nektar._ewriter.NektarExpressionWriter._ex_and (   self,   e  )

protected

Definition at line 91 of file _ewriter.py.

    def _ex_and(self, e):
        return self._ex_infix_condition(e, '&&')
 

_ex_if()

nektar._ewriter.NektarExpressionWriter._ex_if (   self,   e  )

protected

Definition at line 97 of file _ewriter.py.

    def _ex_if(self, e):
        ite = (self.ex(e._i), self.ex(e._t), self.ex(e._e))
        if self._fcond is None:
            return '(%s ? %s : %s)' % ite
        else:
            return '%s(%s, %s, %s)' % ((self._fcond,) + ite)
 

References nektar._ewriter.NektarExpressionWriter._fcond.

_ex_log()

nektar._ewriter.NektarExpressionWriter._ex_log (   self,   e  )

protected

Definition at line 69 of file _ewriter.py.

    def _ex_log(self, e):
        if len(e) == 1:
            return self._ex_function(e, 'log')
        return '(log(' + self.ex(e[0]) + ') / log(' + self.ex(e[1]) + '))'
 

_ex_not()

nektar._ewriter.NektarExpressionWriter._ex_not (   self,   e  )

protected

Definition at line 81 of file _ewriter.py.

    def _ex_not(self, e):
        return '!(' + self.ex(e[0]) + ')'
 

_ex_or()

nektar._ewriter.NektarExpressionWriter._ex_or (   self,   e  )

protected

Definition at line 94 of file _ewriter.py.

    def _ex_or(self, e):
        return self._ex_infix_condition(e, '||')
 

_ex_piecewise()

nektar._ewriter.NektarExpressionWriter._ex_piecewise (   self,   e  )

protected

Definition at line 104 of file _ewriter.py.

    def _ex_piecewise(self, e):
        s = []
        n = len(e._i)
        if self._fcond is None:
            for i in range(0, n):
                s.append('(%s ? %s : ' % (self.ex(e._i[i]), self.ex(e._e[i])))
            s.append(self.ex(e._e[n]))
            s.append(')' * n)
        else:
            for i in range(0, n):
                s.append(
                    '%s(%s, %s, ' % (
                        self._fcond, self.ex(e._i[i]), self.ex(e._e[i])))
            s.append(self.ex(e._e[n]))
            s.append(')' * n)
        return ''.join(s)
 

References nektar._ewriter.NektarExpressionWriter._fcond.

_ex_power()

nektar._ewriter.NektarExpressionWriter._ex_power (   self,   e  )

protected

Definition at line 57 of file _ewriter.py.

    def _ex_power(self, e):
        return 'pow(' + self.ex(e[0]) + ', ' + self.ex(e[1]) + ')'
 

_ex_quotient()

nektar._ewriter.NektarExpressionWriter._ex_quotient (   self,   e  )

protected

Definition at line 45 of file _ewriter.py.

    def _ex_quotient(self, e):
        # Note that this _must_ round towards minus infinity!
        # See myokit.Quotient !
        return self.ex(myokit.Floor(myokit.Divide(e[0], e[1])))
 

_ex_remainder()

nektar._ewriter.NektarExpressionWriter._ex_remainder (   self,   e  )

protected

Definition at line 50 of file _ewriter.py.

    def _ex_remainder(self, e):
        # Note that this _must_ use the same round-to-neg-inf convention as
        # myokit.Quotient! Implementation below is consistent with Python
        # convention:
        return self.ex(myokit.Minus(
            e[0], myokit.Multiply(e[1], myokit.Quotient(e[0], e[1]))))
 

set_condition_function()

nektar._ewriter.NektarExpressionWriter.set_condition_function	(		self,
			func = None
	)

Sets a function name to use for if statements

By setting func to None you can revert back to the default behavior
 (the ternary operator). Any other value will be interpreted as the
 name of a C function taking arguments (condition, value_if_true,
 value_if_false).

Definition at line 24 of file _ewriter.py.

    def set_condition_function(self, func=None):
        """
        Sets a function name to use for if statements
 
        By setting func to None you can revert back to the default behavior
         (the ternary operator). Any other value will be interpreted as the
         name of a C function taking arguments (condition, value_if_true,
         value_if_false).
        """
        self._fcond = func
 

References nektar._ewriter.NektarExpressionWriter._fcond.

Member Data Documentation

_fcond

nektar._ewriter.NektarExpressionWriter._fcond

protected

Definition at line 22 of file _ewriter.py.

Referenced by nektar._ewriter.NektarExpressionWriter._ex_if(), nektar._ewriter.NektarExpressionWriter._ex_piecewise(), and nektar._ewriter.NektarExpressionWriter.set_condition_function().

_function_prefix

nektar._ewriter.NektarExpressionWriter._function_prefix

protected

Definition at line 21 of file _ewriter.py.