Inheritance diagram for CellMLToNektar.pycml.mathml_eq:

[legend]

Public Member Functions
def	evaluate (self)

def	rhs (self)

def	lhs (self)

Public Member Functions inherited from CellMLToNektar.pycml.mathml_operator
def	wrong_number_of_operands (self, found, wanted)

Public Member Functions inherited from CellMLToNektar.pycml.mathml
def	__init__ (self)

def	__repr__ (self)

def	__deepcopy__ (self, memo)

def	clone_self (self, register=False)

def	get_original_of_clone (self)

def	get_component (self)

def	model (self)

def	eval (self, elt)

Public Member Functions inherited from CellMLToNektar.pycml.element_base
def	__delattr__ (self, key)

def	__setattr__ (self, key, value)

def	rootNode (self)

def	cmeta_id (self)

def	xml_remove_child_at (self, index=-1)

def	xml_doc (self)

def	xml_properties (self)

Private Member Functions
def	_is_top_level (self)

def	_set_in_units (self, units, no_act=False)

def	_get_binding_time (self)

def	_reduce (self)

Additional Inherited Members
Static Public Member Functions inherited from CellMLToNektar.pycml.mathml
def	clone (expr)

Public Attributes inherited from CellMLToNektar.pycml.element_base
	xml_attributes

Properties inherited from CellMLToNektar.pycml.mathml
	component = property(get_component)

Detailed Description

Class representing the MathML <eq> operator.

Definition at line 5946 of file pycml.py.

Member Function Documentation

◆ _get_binding_time()

def CellMLToNektar.pycml.mathml_eq._get_binding_time ( self )

private

Return the binding time of the enclosing <apply> element.

If this is a top-level expression, then only recurse into the RHS,
otherwise proceed as normal for an apply.

There is one further special case: if this is a top-level
expression and the variable assigned to is annotated to be
kept in the specialised model, then the expression is dynamic.

Definition at line 6002 of file pycml.py.

     def _get_binding_time(self):
         """Return the binding time of the enclosing <apply> element.
  
         If this is a top-level expression, then only recurse into the RHS,
         otherwise proceed as normal for an apply.
  
         There is one further special case: if this is a top-level
         expression and the variable assigned to is annotated to be
         kept in the specialised model, then the expression is dynamic.
         """
         app = self.xml_parent
         if self._is_top_level():
             annotated_as_kept = False
             if app.is_ode():
                 DEBUG('partial-evaluator', "BT ODE",
                       map(lambda v: v.fullname(), app.assigned_variable()))
             else:
                 DEBUG('partial-evaluator', "BT expr",
                       app.assigned_variable().fullname())
                 if app.assigned_variable().pe_keep:
                     annotated_as_kept = True
             ops = list(app.operands())
             if len(ops) != 2:
                 self.wrong_number_of_operands(len(ops), [2])
             rhs = ops[1]
             bt = app._get_element_binding_time(rhs)
             if annotated_as_kept:
                 bt = BINDING_TIMES.dynamic
         else:
             bt = app._get_binding_time(check_operator=False)
         return bt
  

References CellMLToNektar.pycml.mathml_eq._is_top_level(), CellMLToNektar.utilities.DEBUG(), and CellMLToNektar.pycml.mathml_operator.wrong_number_of_operands().

Referenced by CellMLToNektar.pycml.mathml_ci._reduce(), CellMLToNektar.pycml.mathml_apply._reduce(), CellMLToNektar.pycml.mathml_piecewise._reduce(), CellMLToNektar.pycml.cellml_variable.get_value(), and CellMLToNektar.pycml.cellml_variable.is_statically_const().

◆ _is_top_level()

def CellMLToNektar.pycml.mathml_eq._is_top_level ( self )

private

Return True iff the enclosing <apply> is a top-level expression.

Definition at line 5948 of file pycml.py.

     def _is_top_level(self):
         """Return True iff the enclosing <apply> is a top-level expression."""
         return self.xml_parent.is_top_level()
  

Referenced by CellMLToNektar.pycml.mathml_eq._get_binding_time(), CellMLToNektar.pycml.mathml_eq._reduce(), CellMLToNektar.pycml.mathml_eq._set_in_units(), CellMLToNektar.pycml.mathml_eq.evaluate(), CellMLToNektar.pycml.mathml_eq.lhs(), and CellMLToNektar.pycml.mathml_eq.rhs().

◆ _reduce()

def CellMLToNektar.pycml.mathml_eq._reduce ( self )

private

Reduce this expression by evaluating its static parts.

If this is a top-level assignment, then just reduce the RHS.
Otherwise proceed as normal for an <apply>.

Definition at line 6034 of file pycml.py.

     def _reduce(self):
         """Reduce this expression by evaluating its static parts.
  
         If this is a top-level assignment, then just reduce the RHS.
         Otherwise proceed as normal for an <apply>.
         """
         app = self.xml_parent
         if self._is_top_level():
             ops = list(app.operands())
             if len(ops) != 2:
                 self.wrong_number_of_operands(len(ops), [2])
             rhs = ops[1]
             app._reduce_elt(rhs)
         else:
             app._reduce(check_operator=False)
  

References CellMLToNektar.pycml.mathml_eq._is_top_level(), and CellMLToNektar.pycml.mathml_operator.wrong_number_of_operands().

◆ _set_in_units()

def CellMLToNektar.pycml.mathml_eq._set_in_units	(	self,
		units,
		no_act = `False`
	)

private

Set the units of the application of this operator.

If this is a top-level <eq/>, then force the RHS to take the units
of the LHS.  Otherwise, behave as for other relational operators.

Reimplemented from CellMLToNektar.pycml.mathml_units_mixin_equalise_operands.

Definition at line 5952 of file pycml.py.

     def _set_in_units(self, units, no_act=False):
         """Set the units of the application of this operator.
  
         If this is a top-level <eq/>, then force the RHS to take the units
         of the LHS.  Otherwise, behave as for other relational operators.
         """
         if self._is_top_level():
             ops = self.xml_parent.operands()
             lhs = ops.next()
             lhs_units = lhs.get_units().extract()
             self._set_element_in_units(lhs, lhs_units, no_act)
             self._set_element_in_units(ops.next(), lhs_units, no_act)
             if not no_act:
                 self.xml_parent._cml_units = units
         else:
             super(mathml_eq, self)._set_in_units(units, no_act)
  

References CellMLToNektar.pycml.mathml_eq._is_top_level(), CellMLToNektar.pycml.mathml_units_mixin._set_element_in_units(), and CellMLToNektar.pycml.extract().

◆ evaluate()

def CellMLToNektar.pycml.mathml_eq.evaluate ( self )

Evaluate the enclosing <apply> element.

The behaviour depends on whether the enclosing <apply> is a
top-level expression or not, i.e. whether this is an
assignment or a comparison.

If an assignment, evaluate the RHS, assign the value to
the variable on the LHS, and return it.

If a comparison, return True iff the 2 operands are equal.

Definition at line 5969 of file pycml.py.

     def evaluate(self):
         """Evaluate the enclosing <apply> element.
  
         The behaviour depends on whether the enclosing <apply> is a
         top-level expression or not, i.e. whether this is an
         assignment or a comparison.
  
         If an assignment, evaluate the RHS, assign the value to
         the variable on the LHS, and return it.
  
         If a comparison, return True iff the 2 operands are equal.
         """
         app = self.xml_parent
         ops = list(app.operands())
         if len(ops) != 2:
             self.wrong_number_of_operands(len(ops), [2])
         
         if self._is_top_level():
             # This is a top-level assignment or ODE
             value = self.eval(ops[1])
             var = app.assigned_variable()
             if app.is_assignment():
                 var.set_value(value)
             elif app.is_ode():
                 indepvar = var[1].get_source_variable(recurse=True)
                 var[0].set_value(value, ode=indepvar)
             else:
                 raise EvaluationError("Weird sort of assignment expression.")
         else:
             # This is a comparison
             value = (self.eval(ops[0]) == self.eval(ops[1]))
         return value
  

References CellMLToNektar.pycml.mathml_eq._is_top_level(), CellMLToNektar.pycml.mathml.eval(), and CellMLToNektar.pycml.mathml_operator.wrong_number_of_operands().

Referenced by CellMLToNektar.pycml.mathml_constructor._eval_self(), and CellMLToNektar.pycml.mathml_ci._reduce().

◆ lhs()

def CellMLToNektar.pycml.mathml_eq.lhs ( self )

Return the left hand side of this expression.

Should only be called if we're actually an assignment.

Definition at line 6063 of file pycml.py.

     def lhs(self):
         """Return the left hand side of this expression.
  
         Should only be called if we're actually an assignment.
         """
         if self._is_top_level():
             ops = self.xml_parent.operands()
             return ops.next()
         else:
             raise ValueError("Not an assignment expression.")
  

References CellMLToNektar.pycml.mathml_eq._is_top_level().

◆ rhs()

def CellMLToNektar.pycml.mathml_eq.rhs ( self )

Return the right hand side of this expression.

Should only be called if we're actually an assignment.

Definition at line 6051 of file pycml.py.

     def rhs(self):
         """Return the right hand side of this expression.
  
         Should only be called if we're actually an assignment.
         """
         if self._is_top_level():
             ops = self.xml_parent.operands()
             ops.next()
             return ops.next()
         else:
             raise ValueError("Not an assignment expression.")

References CellMLToNektar.pycml.mathml_eq._is_top_level().

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _get_binding_time()

◆ _is_top_level()

◆ _reduce()

◆ _set_in_units()

◆ evaluate()

◆ lhs()

◆ rhs()