Method expr

SLiCAP/SLiCAPrst.py:611–640

Creates in inline expression. :param expr: Expression :type expression: sympy.Expr :param units: Units :type units: str :param name: Name of the variable for RST substitution. :type name: str: :

(self, expr, units="", name=None)

        return Snippet(RST, self.format)

    def expr(self, expr, units="", name=None):
        """
        Creates in inline expression. 
        
        :param expr: Expression
        :type expression: sympy.Expr
        
        :param units: Units
        :type units: str
        
        :param name: Name of the variable for RST substitution.
        :type name: str:
            
        :return: SLiCAP Snippet object with save variable append mode
        :rtype: SLiCAP.SLiCAPprotos.Snippet
        """
        if type(name) == str and len(name) > 0:
            try:
                units = units2TeX(units)
            except:
                pass
            RST = ':math:`' + sp.latex(roundN(expr))
            if units != '':
                RST += '\\, \\left[ \\mathrm{' + units + '} \\right]` '
            else:
                RST += '` '
            RST = '.. |' + name + '| replace:: ' + RST + '\n'
        else:
            raise NameError
        return Snippet(RST, self.format, mode="a")

    def eqnInline(self, LHS, RHS, units="", name=None):
        """