org.sbml.jsbml.math.compiler

Class LibSBMLFormulaCompiler

java.lang.Object

org.sbml.jsbml.util.StringTools

org.sbml.jsbml.math.compiler.FormulaCompiler

org.sbml.jsbml.math.compiler.LibSBMLFormulaCompiler

All Implemented Interfaces:

ASTNode2Compiler

public class LibSBMLFormulaCompiler
extends FormulaCompiler

Since:

1.0

Version:

$Rev$

Author:

Andreas Dräger, Victor Kofia

Field Summary

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
<T> ASTNode2Value<java.lang.String>	and(java.util.List<ASTNode2> nodes)
<T> ASTNode2Value<java.lang.String>	arccos(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arccosh(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arccot(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arccoth(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arccsc(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arccsch(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arcsec(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arcsech(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arcsin(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arcsinh(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arctan(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	arctanh(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	eq(ASTNode2 left, ASTNode2 right) Equal.
<T> ASTNode2Value<java.lang.String>	factorial(ASTNode2 node)
<T> ASTNode2Value<java.lang.String>	geq(ASTNode2 left, ASTNode2 right) Greater equal.
<T> ASTNode2Value<java.lang.String>	getConstantE()
<T> ASTNode2Value<java.lang.String>	getNegativeInfinity()
<T> ASTNode2Value<java.lang.String>	getPositiveInfinity()
<T> ASTNode2Value<java.lang.String>	gt(ASTNode2 left, ASTNode2 right) Greater than.
<T> ASTNode2Value<java.lang.String>	leq(ASTNode2 left, ASTNode2 right) Less equal.
<T> ASTNode2Value<java.lang.String>	ln(ASTNode2 node) Natural logarithm.
<T> ASTNode2Value<java.lang.String>	log(ASTNode2 node) Logarithm of the given value to base 10.
<T> ASTNode2Value<java.lang.String>	log(ASTNode2 left, ASTNode2 right) Logarithm of the given value to the given base.
<T> ASTNode2Value<java.lang.String>	lt(ASTNode2 left, ASTNode2 right) Less than.
<T> ASTNode2Value<java.lang.String>	neq(ASTNode2 left, ASTNode2 right) Not equal.
<T> ASTNode2Value<java.lang.String>	or(java.util.List<ASTNode2> nodes)
<T> ASTNode2Value<java.lang.String>	pow(ASTNode2 left, ASTNode2 right)
<T> ASTNode2Value<java.lang.String>	root(ASTNode2 rootExponent, ASTNode2 radiant)
<T> ASTNode2Value<java.lang.String>	root(double rootExponent, ASTNode2 radiant)
<T> ASTNode2Value<java.lang.String>	sqrt(ASTNode2 node) Square root.
<T> ASTNode2Value<java.lang.String>	xor(java.util.List<ASTNode2> nodes) Exclusive or.

Methods inherited from class org.sbml.jsbml.math.compiler.FormulaCompiler

abs, brackets, ceiling, checkBrackets, checkDenominatorBrackets, compile, compile, compile, compile, compile, compile, cos, cosh, cot, coth, csc, csch, delay, diff, exp, floor, frac, frac, frac, function, function, function, function, getConstantAvogadro, getConstantFalse, getConstantPi, getConstantTrue, getSpecies, isPrefixNotationInLogicalOperations, lambda, lambdaBody, logicalOperation, minus, not, piecewise, plus, pow, relation, root, sec, sech, selector, selector, setPrefixNotationInLogicalOperations, 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 <T> ASTNode2Value<java.lang.String> arccos(ASTNode2 node)
                                           throws SBMLException

Specified by:

arccos in interface ASTNode2Compiler

Overrides:

arccos in class FormulaCompiler

Returns:

Throws:

SBMLException

arccosh

public <T> ASTNode2Value<java.lang.String> arccosh(ASTNode2 node)
                                            throws SBMLException

Specified by:

arccosh in interface ASTNode2Compiler

Overrides:

arccosh in class FormulaCompiler

Returns:

Throws:

SBMLException

arccot

public <T> ASTNode2Value<java.lang.String> arccot(ASTNode2 node)
                                           throws SBMLException

Specified by:

arccot in interface ASTNode2Compiler

Overrides:

arccot in class FormulaCompiler

Returns:

Throws:

SBMLException

arccoth

public <T> ASTNode2Value<java.lang.String> arccoth(ASTNode2 node)
                                            throws SBMLException

Specified by:

arccoth in interface ASTNode2Compiler

Overrides:

arccoth in class FormulaCompiler

Returns:

Throws:

SBMLException

arccsc

public <T> ASTNode2Value<java.lang.String> arccsc(ASTNode2 node)
                                           throws SBMLException

Specified by:

arccsc in interface ASTNode2Compiler

Overrides:

arccsc in class FormulaCompiler

Returns:

Throws:

SBMLException

arccsch

public <T> ASTNode2Value<java.lang.String> arccsch(ASTNode2 node)
                                            throws SBMLException

Specified by:

arccsch in interface ASTNode2Compiler

Overrides:

arccsch in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsec

public <T> ASTNode2Value<java.lang.String> arcsec(ASTNode2 node)
                                           throws SBMLException

Specified by:

arcsec in interface ASTNode2Compiler

Overrides:

arcsec in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsech

public <T> ASTNode2Value<java.lang.String> arcsech(ASTNode2 node)
                                            throws SBMLException

Specified by:

arcsech in interface ASTNode2Compiler

Overrides:

arcsech in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsin

public <T> ASTNode2Value<java.lang.String> arcsin(ASTNode2 node)
                                           throws SBMLException

Specified by:

arcsin in interface ASTNode2Compiler

Overrides:

arcsin in class FormulaCompiler

Returns:

Throws:

SBMLException

arcsinh

public <T> ASTNode2Value<java.lang.String> arcsinh(ASTNode2 node)
                                            throws SBMLException

Specified by:

arcsinh in interface ASTNode2Compiler

Overrides:

arcsinh in class FormulaCompiler

Returns:

Throws:

SBMLException

arctan

public <T> ASTNode2Value<java.lang.String> arctan(ASTNode2 node)
                                           throws SBMLException

Specified by:

arctan in interface ASTNode2Compiler

Overrides:

arctan in class FormulaCompiler

Returns:

Throws:

SBMLException

arctanh

public <T> ASTNode2Value<java.lang.String> arctanh(ASTNode2 node)
                                            throws SBMLException

Specified by:

arctanh in interface ASTNode2Compiler

Overrides:

arctanh in class FormulaCompiler

Returns:

Throws:

SBMLException

and

public <T> ASTNode2Value<java.lang.String> and(java.util.List<ASTNode2> nodes)
                                        throws SBMLException

Specified by:

and in interface ASTNode2Compiler

Overrides:

and in class FormulaCompiler

Returns:

Throws:

SBMLException

or

public <T> ASTNode2Value<java.lang.String> or(java.util.List<ASTNode2> nodes)
                                       throws SBMLException

Specified by:

or in interface ASTNode2Compiler

Overrides:

or in class FormulaCompiler

Parameters:

nodes - These values must be interpretable as a Boolean.

Returns:

Throws:

SBMLException

xor

public <T> ASTNode2Value<java.lang.String> xor(java.util.List<ASTNode2> nodes)
                                        throws SBMLException

Description copied from interface: ASTNode2Compiler

Exclusive or.

Specified by:

xor in interface ASTNode2Compiler

Overrides:

xor in class FormulaCompiler

Parameters:

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

Returns:

Throws:

SBMLException

eq

public <T> ASTNode2Value<java.lang.String> eq(ASTNode2 left,
                                              ASTNode2 right)
                                       throws SBMLException

Description copied from interface: ASTNode2Compiler

Equal.

Specified by:

eq in interface ASTNode2Compiler

Overrides:

eq in class FormulaCompiler

Returns:

Throws:

SBMLException

neq

public <T> ASTNode2Value<java.lang.String> neq(ASTNode2 left,
                                               ASTNode2 right)
                                        throws SBMLException

Description copied from interface: ASTNode2Compiler

Not equal.

Specified by:

neq in interface ASTNode2Compiler

Overrides:

neq in class FormulaCompiler

Returns:

Throws:

SBMLException

geq

public <T> ASTNode2Value<java.lang.String> geq(ASTNode2 left,
                                               ASTNode2 right)
                                        throws SBMLException

Description copied from interface: ASTNode2Compiler

Greater equal.

Specified by:

geq in interface ASTNode2Compiler

Overrides:

geq in class FormulaCompiler

Returns:

Throws:

SBMLException

gt

public <T> ASTNode2Value<java.lang.String> gt(ASTNode2 left,
                                              ASTNode2 right)
                                       throws SBMLException

Description copied from interface: ASTNode2Compiler

Greater than.

Specified by:

gt in interface ASTNode2Compiler

Overrides:

gt in class FormulaCompiler

Returns:

Throws:

SBMLException

leq

public <T> ASTNode2Value<java.lang.String> leq(ASTNode2 left,
                                               ASTNode2 right)
                                        throws SBMLException

Description copied from interface: ASTNode2Compiler

Less equal.

Specified by:

leq in interface ASTNode2Compiler

Overrides:

leq in class FormulaCompiler

Returns:

Throws:

SBMLException

lt

public <T> ASTNode2Value<java.lang.String> lt(ASTNode2 left,
                                              ASTNode2 right)
                                       throws SBMLException

Description copied from interface: ASTNode2Compiler

Less than.

Specified by:

lt in interface ASTNode2Compiler

Overrides:

lt in class FormulaCompiler

Returns:

Throws:

SBMLException

getNegativeInfinity

public <T> ASTNode2Value<java.lang.String> getNegativeInfinity()

Specified by:

getNegativeInfinity in interface ASTNode2Compiler

Overrides:

getNegativeInfinity in class FormulaCompiler

Returns:

getPositiveInfinity

public <T> ASTNode2Value<java.lang.String> getPositiveInfinity()

Specified by:

getPositiveInfinity in interface ASTNode2Compiler

Overrides:

getPositiveInfinity in class FormulaCompiler

Returns:

pow

public <T> ASTNode2Value<java.lang.String> pow(ASTNode2 left,
                                               ASTNode2 right)
                                        throws SBMLException

Specified by:

pow in interface ASTNode2Compiler

Overrides:

pow in class FormulaCompiler

Returns:

Throws:

SBMLException

ln

public <T> ASTNode2Value<java.lang.String> ln(ASTNode2 node)
                                       throws SBMLException

Description copied from interface: ASTNode2Compiler

Natural logarithm.

Specified by:

ln in interface ASTNode2Compiler

Overrides:

ln in class FormulaCompiler

Returns:

Throws:

SBMLException

log

public <T> ASTNode2Value<java.lang.String> log(ASTNode2 node)
                                        throws SBMLException

Description copied from interface: ASTNode2Compiler

Logarithm of the given value to base 10.

Specified by:

log in interface ASTNode2Compiler

Overrides:

log in class FormulaCompiler

Returns:

Throws:

SBMLException

log

public <T> ASTNode2Value<java.lang.String> log(ASTNode2 left,
                                               ASTNode2 right)
                                        throws SBMLException

Description copied from interface: ASTNode2Compiler

Logarithm of the given value to the given base.

Specified by:

log in interface ASTNode2Compiler

Overrides:

log in class FormulaCompiler

Returns:

Throws:

SBMLException

getConstantE

public <T> ASTNode2Value<java.lang.String> getConstantE()

Specified by:

getConstantE in interface ASTNode2Compiler

Overrides:

getConstantE in class FormulaCompiler

Returns:

factorial

public <T> ASTNode2Value<java.lang.String> factorial(ASTNode2 node)

Specified by:

factorial in interface ASTNode2Compiler

Overrides:

factorial in class FormulaCompiler

Returns:

root

public <T> ASTNode2Value<java.lang.String> root(ASTNode2 rootExponent,
                                                ASTNode2 radiant)
                                         throws SBMLException

Specified by:

root in interface ASTNode2Compiler

Overrides:

root in class FormulaCompiler

Returns:

Throws:

SBMLException

root

public <T> ASTNode2Value<java.lang.String> root(double rootExponent,
                                                ASTNode2 radiant)
                                         throws SBMLException

Specified by:

root in interface ASTNode2Compiler

Overrides:

root in class FormulaCompiler

Returns:

Throws:

SBMLException

sqrt

public <T> ASTNode2Value<java.lang.String> sqrt(ASTNode2 node)
                                         throws SBMLException

Description copied from interface: ASTNode2Compiler

Square root.

Specified by:

sqrt in interface ASTNode2Compiler

Overrides:

sqrt in class FormulaCompiler

Parameters:

node - This value must be interpretable as a Number.

Returns:

Throws:

SBMLException