org.sbml.jsbml.ext.arrays.compiler

Class ArraysCompiler

java.lang.Object

org.sbml.jsbml.ext.arrays.compiler.ArraysCompiler

All Implemented Interfaces:

ASTNodeCompiler

public class ArraysCompiler
extends Object
implements ASTNodeCompiler

This compiler is used to evaluate an ASTNode object to a real number.

Since:

1.0

Author:

Leandro Watanabe

Constructor Summary

Constructors

Constructor and Description
ArraysCompiler() Constructs an ArraysCompiler object.
ArraysCompiler(ArraysCompiler obj) Clone constructor

Method Summary

Modifier and Type	Method and Description
ASTNodeValue	abs(ASTNode value)
Double	addValue(String name, double value) Adds a new string,double pair to the idToValue.
ASTNodeValue	and(List<ASTNode> values)
ASTNodeValue	arccos(ASTNode value)
ASTNodeValue	arccosh(ASTNode value)
ASTNodeValue	arccot(ASTNode value)
ASTNodeValue	arccoth(ASTNode value)
ASTNodeValue	arccsc(ASTNode value)
ASTNodeValue	arccsch(ASTNode value)
ASTNodeValue	arcsec(ASTNode value)
ASTNodeValue	arcsech(ASTNode value)
ASTNodeValue	arcsin(ASTNode value)
ASTNodeValue	arcsinh(ASTNode value)
ASTNodeValue	arctan(ASTNode value)
ASTNodeValue	arctanh(ASTNode value)
ASTNodeValue	ceiling(ASTNode value)
ArraysCompiler	clone()
ASTNodeValue	compile(CallableSBase variable)
ASTNodeValue	compile(Compartment c)
ASTNodeValue	compile(double mantissa, int exponent, String units)
ASTNodeValue	compile(double real, String units)
ASTNodeValue	compile(int integer, String units)
ASTNodeValue	compile(String name)
ASTNodeValue	cos(ASTNode value)
ASTNodeValue	cosh(ASTNode value)
ASTNodeValue	cot(ASTNode value)
ASTNodeValue	coth(ASTNode value)
ASTNodeValue	csc(ASTNode value)
ASTNodeValue	csch(ASTNode value)
ASTNodeValue	delay(String delayName, ASTNode x, ASTNode delay, String timeUnits)
ASTNodeValue	eq(ASTNode left, ASTNode right)
ASTNodeValue	exp(ASTNode value)
ASTNodeValue	factorial(ASTNode value)
ASTNodeValue	floor(ASTNode value)
ASTNodeValue	frac(ASTNode numerator, ASTNode denominator)
ASTNodeValue	frac(int numerator, int denominator)
ASTNodeValue	function(FunctionDefinition functionDefinition, List<ASTNode> args)
ASTNodeValue	function(String functionDefinitionName, List<ASTNode> args)
ASTNodeValue	geq(ASTNode left, ASTNode right)
ASTNodeValue	getConstantAvogadro(String name)
ASTNodeValue	getConstantE()
ASTNodeValue	getConstantFalse()
ASTNodeValue	getConstantPi()
ASTNodeValue	getConstantTrue()
int	getFieldCount() Returns the number of values in this ArraysCompiler.
Map<String,Double>	getMapIdToValue() Returns the idToValue Map.
ASTNodeValue	getNegativeInfinity()
ASTNodeValue	getPositiveInfinity()
ASTNodeValue	getRateOf(ASTNode name)
double	getValue(String name) Gets an element from the idToValue, with the given id.
ASTNodeValue	gt(ASTNode left, ASTNode right)
ASTNodeValue	implies(List<ASTNode> values)
boolean	isSetidToValue() Returns true, if idToValue contains at least one element.
ASTNodeValue	lambda(List<ASTNode> values)
ASTNodeValue	leq(ASTNode left, ASTNode right)
ASTNodeValue	ln(ASTNode value)
ASTNodeValue	log(ASTNode value)
ASTNodeValue	log(ASTNode base, ASTNode value)
ASTNodeValue	lt(ASTNode left, ASTNode right)
ASTNodeValue	max(List<ASTNode> values)
ASTNodeValue	min(List<ASTNode> values)
ASTNodeValue	minus(List<ASTNode> values)
ASTNodeValue	neq(ASTNode left, ASTNode right)
ASTNodeValue	not(ASTNode value)
ASTNodeValue	or(List<ASTNode> values)
ASTNodeValue	piecewise(List<ASTNode> values)
ASTNodeValue	plus(List<ASTNode> values)
ASTNodeValue	pow(ASTNode base, ASTNode exponent)
ASTNodeValue	quotient(List<ASTNode> values)
ASTNodeValue	rem(List<ASTNode> values)
double	removeField(String id) Removes an element from the idToValue.
ASTNodeValue	root(ASTNode rootExponent, ASTNode radiant)
ASTNodeValue	root(double rootExponent, ASTNode radiant)
ASTNodeValue	sec(ASTNode value)
ASTNodeValue	sech(ASTNode value)
ASTNodeValue	selector(List<ASTNode> nodes)
void	setidToValue(Map<String,Double> idToValue) Sets the given map.
ASTNodeValue	sin(ASTNode value)
ASTNodeValue	sinh(ASTNode value)
ASTNodeValue	sqrt(ASTNode radiant)
ASTNodeValue	symbolTime(String time)
ASTNodeValue	tan(ASTNode value)
ASTNodeValue	tanh(ASTNode value)
ASTNodeValue	times(List<ASTNode> values)
ASTNodeValue	uMinus(ASTNode value)
ASTNodeValue	unknownValue()
boolean	unsetidToValue() Returns true, if idToValue contain at least one element, otherwise false.
ASTNodeValue	vector(List<ASTNode> nodes)
ASTNodeValue	xor(List<ASTNode> values)

Methods inherited from class java.lang.Object

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

Constructor Detail

ArraysCompiler

public ArraysCompiler()

Constructs an ArraysCompiler object.

ArraysCompiler

public ArraysCompiler(ArraysCompiler obj)

Clone constructor

Parameters:

obj - the instance to clone

Method Detail

clone

public ArraysCompiler clone()

Overrides:

clone in class Object

isSetidToValue

public boolean isSetidToValue()

Returns true, if idToValue contains at least one element.

Returns:

true, if idToValue contains at least one element, otherwise false.

getMapIdToValue

public Map<String,Double> getMapIdToValue()

Returns the idToValue Map. Creates it if it is not already existing.

Returns:

the idToValue Map.

setidToValue

public void setidToValue(Map<String,Double> idToValue)

Sets the given map. If idToValue was defined before and contains some elements, they are all unset.

Parameters:

idToValue -

unsetidToValue

public boolean unsetidToValue()

Returns true, if idToValue contain at least one element, otherwise false.

Returns:

true, if idToValue contain at least one element, otherwise false.

addValue

public Double addValue(String name,
                       double value)

Adds a new string,double pair to the idToValue.

The idToValue is initialized if necessary.

Parameters:

name - the element name to add to the map

value - the value of the element to add to the map

Returns:

as specified by Map.put(K, V)

removeField

public double removeField(String id)

Removes an element from the idToValue.

Parameters:

id - the id of the element to be removed from the list.

Returns:

the removed element, if it was successfully found and removed.

getValue

public double getValue(String name)

Gets an element from the idToValue, with the given id.

Parameters:

name - the id of the element to get.

Returns:

the value of the element from the idToValue with the given id.

getFieldCount

public int getFieldCount()

Returns the number of values in this ArraysCompiler.

Returns:

abs

public ASTNodeValue abs(ASTNode value)
                 throws SBMLException

Specified by:

abs in interface ASTNodeCompiler

Throws:

SBMLException

and

public ASTNodeValue and(List<ASTNode> values)
                 throws SBMLException

Specified by:

and in interface ASTNodeCompiler

Throws:

SBMLException

arccos

public ASTNodeValue arccos(ASTNode value)
                    throws SBMLException

Specified by:

arccos in interface ASTNodeCompiler

Throws:

SBMLException

arccosh

public ASTNodeValue arccosh(ASTNode value)
                     throws SBMLException

Specified by:

arccosh in interface ASTNodeCompiler

Throws:

SBMLException

arccot

public ASTNodeValue arccot(ASTNode value)
                    throws SBMLException

Specified by:

arccot in interface ASTNodeCompiler

Throws:

SBMLException

arccoth

public ASTNodeValue arccoth(ASTNode value)
                     throws SBMLException

Specified by:

arccoth in interface ASTNodeCompiler

Throws:

SBMLException

arccsc

public ASTNodeValue arccsc(ASTNode value)
                    throws SBMLException

Specified by:

arccsc in interface ASTNodeCompiler

Throws:

SBMLException

arccsch

public ASTNodeValue arccsch(ASTNode value)
                     throws SBMLException

Specified by:

arccsch in interface ASTNodeCompiler

Throws:

SBMLException

arcsec

public ASTNodeValue arcsec(ASTNode value)
                    throws SBMLException

Specified by:

arcsec in interface ASTNodeCompiler

Throws:

SBMLException

arcsech

public ASTNodeValue arcsech(ASTNode value)
                     throws SBMLException

Specified by:

arcsech in interface ASTNodeCompiler

Throws:

SBMLException

arcsin

public ASTNodeValue arcsin(ASTNode value)
                    throws SBMLException

Specified by:

arcsin in interface ASTNodeCompiler

Throws:

SBMLException

arcsinh

public ASTNodeValue arcsinh(ASTNode value)
                     throws SBMLException

Specified by:

arcsinh in interface ASTNodeCompiler

Throws:

SBMLException

arctan

public ASTNodeValue arctan(ASTNode value)
                    throws SBMLException

Specified by:

arctan in interface ASTNodeCompiler

Throws:

SBMLException

arctanh

public ASTNodeValue arctanh(ASTNode value)
                     throws SBMLException

Specified by:

arctanh in interface ASTNodeCompiler

Throws:

SBMLException

ceiling

public ASTNodeValue ceiling(ASTNode value)
                     throws SBMLException

Specified by:

ceiling in interface ASTNodeCompiler

Throws:

SBMLException

compile

public ASTNodeValue compile(Compartment c)

Specified by:

compile in interface ASTNodeCompiler

compile

public ASTNodeValue compile(double mantissa,
                            int exponent,
                            String units)

Specified by:

compile in interface ASTNodeCompiler

compile

public ASTNodeValue compile(double real,
                            String units)

Specified by:

compile in interface ASTNodeCompiler

compile

public ASTNodeValue compile(int integer,
                            String units)

Specified by:

compile in interface ASTNodeCompiler

compile

public ASTNodeValue compile(CallableSBase variable)
                     throws SBMLException

Specified by:

compile in interface ASTNodeCompiler

Throws:

SBMLException

compile

public ASTNodeValue compile(String name)

Specified by:

compile in interface ASTNodeCompiler

cos

public ASTNodeValue cos(ASTNode value)
                 throws SBMLException

Specified by:

cos in interface ASTNodeCompiler

Throws:

SBMLException

cosh

public ASTNodeValue cosh(ASTNode value)
                  throws SBMLException

Specified by:

cosh in interface ASTNodeCompiler

Throws:

SBMLException

cot

public ASTNodeValue cot(ASTNode value)
                 throws SBMLException

Specified by:

cot in interface ASTNodeCompiler

Throws:

SBMLException

coth

public ASTNodeValue coth(ASTNode value)
                  throws SBMLException

Specified by:

coth in interface ASTNodeCompiler

Throws:

SBMLException

csc

public ASTNodeValue csc(ASTNode value)
                 throws SBMLException

Specified by:

csc in interface ASTNodeCompiler

Throws:

SBMLException

csch

public ASTNodeValue csch(ASTNode value)
                  throws SBMLException

Specified by:

csch in interface ASTNodeCompiler

Throws:

SBMLException

delay

public ASTNodeValue delay(String delayName,
                          ASTNode x,
                          ASTNode delay,
                          String timeUnits)
                   throws SBMLException

Specified by:

delay in interface ASTNodeCompiler

Throws:

SBMLException

eq

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

Specified by:

eq in interface ASTNodeCompiler

Throws:

SBMLException

exp

public ASTNodeValue exp(ASTNode value)
                 throws SBMLException

Specified by:

exp in interface ASTNodeCompiler

Throws:

SBMLException

factorial

public ASTNodeValue factorial(ASTNode value)
                       throws SBMLException

Specified by:

factorial in interface ASTNodeCompiler

Throws:

SBMLException

floor

public ASTNodeValue floor(ASTNode value)
                   throws SBMLException

Specified by:

floor in interface ASTNodeCompiler

Throws:

SBMLException

frac

public ASTNodeValue frac(ASTNode numerator,
                         ASTNode denominator)
                  throws SBMLException

Specified by:

frac in interface ASTNodeCompiler

Throws:

SBMLException

frac

public ASTNodeValue frac(int numerator,
                         int denominator)
                  throws SBMLException

Specified by:

frac in interface ASTNodeCompiler

Throws:

SBMLException

function

public ASTNodeValue function(FunctionDefinition functionDefinition,
                             List<ASTNode> args)
                      throws SBMLException

Specified by:

function in interface ASTNodeCompiler

Throws:

SBMLException

function

public ASTNodeValue function(String functionDefinitionName,
                             List<ASTNode> args)
                      throws SBMLException

Specified by:

function in interface ASTNodeCompiler

Throws:

SBMLException

geq

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

Specified by:

geq in interface ASTNodeCompiler

Throws:

SBMLException

getConstantAvogadro

public ASTNodeValue getConstantAvogadro(String name)

Specified by:

getConstantAvogadro in interface ASTNodeCompiler

getConstantE

public ASTNodeValue getConstantE()

Specified by:

getConstantE in interface ASTNodeCompiler

getConstantFalse

public ASTNodeValue getConstantFalse()

Specified by:

getConstantFalse in interface ASTNodeCompiler

getConstantPi

public ASTNodeValue getConstantPi()

Specified by:

getConstantPi in interface ASTNodeCompiler

getConstantTrue

public ASTNodeValue getConstantTrue()

Specified by:

getConstantTrue in interface ASTNodeCompiler

getNegativeInfinity

public ASTNodeValue getNegativeInfinity()
                                 throws SBMLException

Specified by:

getNegativeInfinity in interface ASTNodeCompiler

Throws:

SBMLException

getPositiveInfinity

public ASTNodeValue getPositiveInfinity()

Specified by:

getPositiveInfinity in interface ASTNodeCompiler

gt

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

Specified by:

gt in interface ASTNodeCompiler

Throws:

SBMLException

lambda

public ASTNodeValue lambda(List<ASTNode> values)
                    throws SBMLException

Specified by:

lambda in interface ASTNodeCompiler

Throws:

SBMLException

leq

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

Specified by:

leq in interface ASTNodeCompiler

Throws:

SBMLException

ln

public ASTNodeValue ln(ASTNode value)
                throws SBMLException

Specified by:

ln in interface ASTNodeCompiler

Throws:

SBMLException

log

public ASTNodeValue log(ASTNode value)
                 throws SBMLException

Specified by:

log in interface ASTNodeCompiler

Throws:

SBMLException

log

public ASTNodeValue log(ASTNode base,
                        ASTNode value)
                 throws SBMLException

Specified by:

log in interface ASTNodeCompiler

Throws:

SBMLException

lt

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

Specified by:

lt in interface ASTNodeCompiler

Throws:

SBMLException

minus

public ASTNodeValue minus(List<ASTNode> values)
                   throws SBMLException

Specified by:

minus in interface ASTNodeCompiler

Throws:

SBMLException

neq

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

Specified by:

neq in interface ASTNodeCompiler

Throws:

SBMLException

not

public ASTNodeValue not(ASTNode value)
                 throws SBMLException

Specified by:

not in interface ASTNodeCompiler

Throws:

SBMLException

or

public ASTNodeValue or(List<ASTNode> values)
                throws SBMLException

Specified by:

or in interface ASTNodeCompiler

Throws:

SBMLException

piecewise

public ASTNodeValue piecewise(List<ASTNode> values)
                       throws SBMLException

Specified by:

piecewise in interface ASTNodeCompiler

Throws:

SBMLException

plus

public ASTNodeValue plus(List<ASTNode> values)
                  throws SBMLException

Specified by:

plus in interface ASTNodeCompiler

Throws:

SBMLException

pow

public ASTNodeValue pow(ASTNode base,
                        ASTNode exponent)
                 throws SBMLException

Specified by:

pow in interface ASTNodeCompiler

Throws:

SBMLException

root

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

Specified by:

root in interface ASTNodeCompiler

Throws:

SBMLException

root

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

Specified by:

root in interface ASTNodeCompiler

Throws:

SBMLException

sec

public ASTNodeValue sec(ASTNode value)
                 throws SBMLException

Specified by:

sec in interface ASTNodeCompiler

Throws:

SBMLException

sech

public ASTNodeValue sech(ASTNode value)
                  throws SBMLException

Specified by:

sech in interface ASTNodeCompiler

Throws:

SBMLException

selector

public ASTNodeValue selector(List<ASTNode> nodes)
                      throws SBMLException

Specified by:

selector in interface ASTNodeCompiler

Throws:

SBMLException

sin

public ASTNodeValue sin(ASTNode value)
                 throws SBMLException

Specified by:

sin in interface ASTNodeCompiler

Throws:

SBMLException

sinh

public ASTNodeValue sinh(ASTNode value)
                  throws SBMLException

Specified by:

sinh in interface ASTNodeCompiler

Throws:

SBMLException

sqrt

public ASTNodeValue sqrt(ASTNode radiant)
                  throws SBMLException

Specified by:

sqrt in interface ASTNodeCompiler

Throws:

SBMLException

symbolTime

public ASTNodeValue symbolTime(String time)

Specified by:

symbolTime in interface ASTNodeCompiler

tan

public ASTNodeValue tan(ASTNode value)
                 throws SBMLException

Specified by:

tan in interface ASTNodeCompiler

Throws:

SBMLException

tanh

public ASTNodeValue tanh(ASTNode value)
                  throws SBMLException

Specified by:

tanh in interface ASTNodeCompiler

Throws:

SBMLException

times

public ASTNodeValue times(List<ASTNode> values)
                   throws SBMLException

Specified by:

times in interface ASTNodeCompiler

Throws:

SBMLException

uMinus

public ASTNodeValue uMinus(ASTNode value)
                    throws SBMLException

Specified by:

uMinus in interface ASTNodeCompiler

Throws:

SBMLException

unknownValue

public ASTNodeValue unknownValue()
                          throws SBMLException

Specified by:

unknownValue in interface ASTNodeCompiler

Throws:

SBMLException

vector

public ASTNodeValue vector(List<ASTNode> nodes)
                    throws SBMLException

Specified by:

vector in interface ASTNodeCompiler

Throws:

SBMLException

xor

public ASTNodeValue xor(List<ASTNode> values)
                 throws SBMLException

Specified by:

xor in interface ASTNodeCompiler

Throws:

SBMLException

max

public ASTNodeValue max(List<ASTNode> values)

Specified by:

max in interface ASTNodeCompiler

min

public ASTNodeValue min(List<ASTNode> values)

Specified by:

min in interface ASTNodeCompiler

quotient

public ASTNodeValue quotient(List<ASTNode> values)

Specified by:

quotient in interface ASTNodeCompiler

rem

public ASTNodeValue rem(List<ASTNode> values)

Specified by:

rem in interface ASTNodeCompiler

implies

public ASTNodeValue implies(List<ASTNode> values)

Specified by:

implies in interface ASTNodeCompiler

getRateOf

public ASTNodeValue getRateOf(ASTNode name)

Specified by:

getRateOf in interface ASTNodeCompiler