org.sbml.jsbml.util.compilers

Class LibSBMLFormulaCompiler

java.lang.Object

org.sbml.jsbml.util.StringTools

org.sbml.jsbml.util.compilers.FormulaCompiler

org.sbml.jsbml.util.compilers.LibSBMLFormulaCompiler

All Implemented Interfaces:

ASTNodeCompiler

public class LibSBMLFormulaCompiler
extends FormulaCompiler

This class creates C-like infix formula Strings that represent the content of ASTNodes and try to reproduce the output generated by the LibSBML historical parser (compatible with SBML L1 infix).

This class give an output that is closer to the output produced by the libSBML formulaToString method.

Since:

1.0

Version:

$Rev$

Field Summary

Fields inherited from class org.sbml.jsbml.util.compilers.FormulaCompiler

EXPONENTIALE, FORMULA_ARGUMENT_SEPARATOR, INVERSE_TRIGONOMETRIC_PREFIX

Fields inherited from class org.sbml.jsbml.util.StringTools

DECIMAL_FORMAT, REAL_FORMAT, SCIENTIFIC_FORMAT, underscore

Constructor Summary

Constructors

Constructor and Description
LibSBMLFormulaCompiler()

Method Summary

Modifier and Type	Method and Description
ASTNodeValue	and(java.util.List<ASTNode> nodes)
ASTNodeValue	arccos(ASTNode node)
ASTNodeValue	arccosh(ASTNode node)
ASTNodeValue	arccot(ASTNode node)
ASTNodeValue	arccoth(ASTNode node)
ASTNodeValue	arccsc(ASTNode node)
ASTNodeValue	arccsch(ASTNode node)
ASTNodeValue	arcsec(ASTNode node)
ASTNodeValue	arcsech(ASTNode node)
ASTNodeValue	arcsin(ASTNode node)
ASTNodeValue	arcsinh(ASTNode node)
ASTNodeValue	arctan(ASTNode node)
ASTNodeValue	arctanh(ASTNode node)
ASTNodeValue	eq(ASTNode left, ASTNode right) Equal.
ASTNodeValue	factorial(ASTNode node)
ASTNodeValue	geq(ASTNode left, ASTNode right) Greater equal.
ASTNodeValue	getConstantE()
ASTNodeValue	getNegativeInfinity()
ASTNodeValue	getPositiveInfinity()
ASTNodeValue	gt(ASTNode left, ASTNode right) Greater than.
ASTNodeValue	leq(ASTNode left, ASTNode right) Less equal.
ASTNodeValue	ln(ASTNode node) Natural logarithm.
ASTNodeValue	log(ASTNode node) Logarithm of the given value to base 10.
ASTNodeValue	log(ASTNode left, ASTNode right) Logarithm of the given value to the given base.
ASTNodeValue	lt(ASTNode left, ASTNode right) Less than.
ASTNodeValue	neq(ASTNode left, ASTNode right) Not equal.
ASTNodeValue	or(java.util.List<ASTNode> nodes)
ASTNodeValue	pow(ASTNode left, ASTNode right)
ASTNodeValue	root(ASTNode rootExponent, ASTNode radiant)
ASTNodeValue	root(double rootExponent, ASTNode radiant)
ASTNodeValue	sqrt(ASTNode node) Square root.
ASTNodeValue	xor(java.util.List<ASTNode> nodes) Exclusive or.

Methods inherited from class org.sbml.jsbml.util.compilers.FormulaCompiler

abs, brackets, ceiling, checkBrackets, checkDenominatorBrackets, checkRelationalArgumentBrackets, compile, compile, compile, compile, compile, compile, cos, cosh, cot, coth, csc, csch, delay, diff, exp, floor, frac, frac, frac, function, function, function, getConstantAvogadro, getConstantFalse, getConstantPi, getConstantTrue, getRateOf, getSpecies, getStoichiometry, implies, lambda, lambdaBody, logicalOperation, logicalOperationFunction, max, min, minus, not, piecewise, plus, pow, quotient, relation, rem, root, sec, sech, selector, selector, sin, sinh, sqrt, sum, symbolTime, tan, tanh, times, times, uMinus, unknownValue, vector, vector

Methods inherited from class org.sbml.jsbml.util.StringTools

append, append, concat, concatStringBuilder, encodeForHTML, fill, fill, firstLetterLowerCase, firstLetterUpperCase, getWordForNumber, leadingZeros, newLine, parseSBMLBoolean, parseSBMLDouble, parseSBMLInt, parseSBMLShort, toHTML, toHTML, toString, toString, toXMLAnnotationString, toXMLMessageString, toXMLNotesString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LibSBMLFormulaCompiler

public LibSBMLFormulaCompiler()

Method Detail

arccos

public ASTNodeValue arccos(ASTNode node)
                    throws SBMLException

Specified by:

arccos in interface ASTNodeCompiler

Overrides:

arccos in class FormulaCompiler

Returns:

Throws:

SBMLException

arccosh

public ASTNodeValue arccosh(ASTNode node)
                     throws SBMLException

Specified by:

arccosh in interface ASTNodeCompiler

Overrides:

arccosh in class FormulaCompiler

Returns:

Throws:

SBMLException

arccot

public ASTNodeValue arccot(ASTNode node)
                    throws SBMLException

Specified by:

arccot in interface ASTNodeCompiler

Overrides:

arccot in class FormulaCompiler

Returns:

Throws:

SBMLException

arccoth

public ASTNodeValue arccoth(ASTNode node)
                     throws SBMLException

Specified by:

arccoth in interface ASTNodeCompiler

Overrides:

arccoth in class FormulaCompiler

Returns:

Throws:

SBMLException

arccsc

public ASTNodeValue arccsc(ASTNode node)
                    throws SBMLException

Specified by:

arccsc in interface ASTNodeCompiler

Overrides:

arccsc in class FormulaCompiler

Returns:

Throws:

SBMLException

arccsch

public ASTNodeValue arccsch(ASTNode node)
                     throws SBMLException

Specified by:

arccsch in interface ASTNodeCompiler

Overrides:

arccsch in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsec

public ASTNodeValue arcsec(ASTNode node)
                    throws SBMLException

Specified by:

arcsec in interface ASTNodeCompiler

Overrides:

arcsec in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsech

public ASTNodeValue arcsech(ASTNode node)
                     throws SBMLException

Specified by:

arcsech in interface ASTNodeCompiler

Overrides:

arcsech in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsin

public ASTNodeValue arcsin(ASTNode node)
                    throws SBMLException

Specified by:

arcsin in interface ASTNodeCompiler

Overrides:

arcsin in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsinh

public ASTNodeValue arcsinh(ASTNode node)
                     throws SBMLException

Specified by:

arcsinh in interface ASTNodeCompiler

Overrides:

arcsinh in class FormulaCompiler

Returns:

Throws:

SBMLException

arctan

public ASTNodeValue arctan(ASTNode node)
                    throws SBMLException

Specified by:

arctan in interface ASTNodeCompiler

Overrides:

arctan in class FormulaCompiler

Returns:

Throws:

SBMLException

arctanh

public ASTNodeValue arctanh(ASTNode node)
                     throws SBMLException

Specified by:

arctanh in interface ASTNodeCompiler

Overrides:

arctanh in class FormulaCompiler

Returns:

Throws:

SBMLException

and

public ASTNodeValue and(java.util.List<ASTNode> nodes)
                 throws SBMLException

Specified by:

and in interface ASTNodeCompiler

Overrides:

and in class FormulaCompiler

Returns:

Throws:

SBMLException

or

public ASTNodeValue or(java.util.List<ASTNode> nodes)
                throws SBMLException

Specified by:

or in interface ASTNodeCompiler

Overrides:

or in class FormulaCompiler

Parameters:

nodes - These values must be interpretable as a Boolean.

Returns:

Throws:

SBMLException

xor

public ASTNodeValue xor(java.util.List<ASTNode> nodes)
                 throws SBMLException

Description copied from interface: ASTNodeCompiler

Exclusive or.

Specified by:

xor in interface ASTNodeCompiler

Overrides:

xor in class FormulaCompiler

Parameters:

nodes - It must be possible to evaluate the given values to Boolean.

Returns:

Throws:

SBMLException

eq

public ASTNodeValue eq(ASTNode left,
                       ASTNode right)
                throws SBMLException

Description copied from interface: ASTNodeCompiler

Equal.

Specified by:

eq in interface ASTNodeCompiler

Overrides:

eq in class FormulaCompiler

Returns:

Throws:

SBMLException

neq

public ASTNodeValue neq(ASTNode left,
                        ASTNode right)
                 throws SBMLException

Description copied from interface: ASTNodeCompiler

Not equal.

Specified by:

neq in interface ASTNodeCompiler

Overrides:

neq in class FormulaCompiler

Returns:

Throws:

SBMLException

geq

public ASTNodeValue geq(ASTNode left,
                        ASTNode right)
                 throws SBMLException

Description copied from interface: ASTNodeCompiler

Greater equal.

Specified by:

geq in interface ASTNodeCompiler

Overrides:

geq in class FormulaCompiler

Returns:

Throws:

SBMLException

gt

public ASTNodeValue gt(ASTNode left,
                       ASTNode right)
                throws SBMLException

Description copied from interface: ASTNodeCompiler

Greater than.

Specified by:

gt in interface ASTNodeCompiler

Overrides:

gt in class FormulaCompiler

Returns:

Throws:

SBMLException

leq

public ASTNodeValue leq(ASTNode left,
                        ASTNode right)
                 throws SBMLException

Description copied from interface: ASTNodeCompiler

Less equal.

Specified by:

leq in interface ASTNodeCompiler

Overrides:

leq in class FormulaCompiler

Returns:

Throws:

SBMLException

lt

public ASTNodeValue lt(ASTNode left,
                       ASTNode right)
                throws SBMLException

Description copied from interface: ASTNodeCompiler

Less than.

Specified by:

lt in interface ASTNodeCompiler

Overrides:

lt in class FormulaCompiler

Returns:

Throws:

SBMLException

getNegativeInfinity

public ASTNodeValue getNegativeInfinity()

Specified by:

getNegativeInfinity in interface ASTNodeCompiler

Overrides:

getNegativeInfinity in class FormulaCompiler

Returns:

getPositiveInfinity

public ASTNodeValue getPositiveInfinity()

Specified by:

getPositiveInfinity in interface ASTNodeCompiler

Overrides:

getPositiveInfinity in class FormulaCompiler

Returns:

pow

public ASTNodeValue pow(ASTNode left,
                        ASTNode right)
                 throws SBMLException

Specified by:

pow in interface ASTNodeCompiler

Overrides:

pow in class FormulaCompiler

Returns:

Throws:

SBMLException

ln

public ASTNodeValue ln(ASTNode node)
                throws SBMLException

Description copied from interface: ASTNodeCompiler

Natural logarithm.

Specified by:

ln in interface ASTNodeCompiler

Overrides:

ln in class FormulaCompiler

Returns:

Throws:

SBMLException

log

public ASTNodeValue log(ASTNode node)
                 throws SBMLException

Description copied from interface: ASTNodeCompiler

Logarithm of the given value to base 10.

Specified by:

log in interface ASTNodeCompiler

Overrides:

log in class FormulaCompiler

Returns:

Throws:

SBMLException

log

public ASTNodeValue log(ASTNode left,
                        ASTNode right)
                 throws SBMLException

Description copied from interface: ASTNodeCompiler

Logarithm of the given value to the given base.

Specified by:

log in interface ASTNodeCompiler

Overrides:

log in class FormulaCompiler

Returns:

Throws:

SBMLException

getConstantE

public ASTNodeValue getConstantE()

Specified by:

getConstantE in interface ASTNodeCompiler

Overrides:

getConstantE in class FormulaCompiler

Returns:

factorial

public ASTNodeValue factorial(ASTNode node)

Specified by:

factorial in interface ASTNodeCompiler

Overrides:

factorial in class FormulaCompiler

Returns:

root

public ASTNodeValue root(ASTNode rootExponent,
                         ASTNode radiant)
                  throws SBMLException

Specified by:

root in interface ASTNodeCompiler

Overrides:

root in class FormulaCompiler

Returns:

Throws:

SBMLException

root

public ASTNodeValue root(double rootExponent,
                         ASTNode radiant)
                  throws SBMLException

Specified by:

root in interface ASTNodeCompiler

Overrides:

root in class FormulaCompiler

Returns:

Throws:

SBMLException

sqrt

public ASTNodeValue sqrt(ASTNode node)
                  throws SBMLException

Description copied from interface: ASTNodeCompiler

Square root.

Specified by:

sqrt in interface ASTNodeCompiler

Overrides:

sqrt in class FormulaCompiler

Parameters:

node - This value must be interpretable as a Number.

Returns:

Throws:

SBMLException