doc_astnode_types Class Reference

Detailed Description

Every ASTNode has an associated type code to indicate whether, for example, it holds a number or stands for an arithmetic operator. The type is recorded as a value drawn from the enumeration ASTNodeType_t . The list of possible types is quite long, because it covers all the mathematical functions that are permitted in SBML. The values are shown in the following table:

AST_CONSTANT_E	AST_FUNCTION_COT	AST_LOGICAL_NOT
AST_CONSTANT_FALSE	AST_FUNCTION_COTH	AST_LOGICAL_OR
AST_CONSTANT_PI	AST_FUNCTION_CSC	AST_LOGICAL_XOR
AST_CONSTANT_TRUE	AST_FUNCTION_CSCH	AST_MINUS
AST_DIVIDE	AST_FUNCTION_DELAY	AST_NAME
AST_FUNCTION	AST_FUNCTION_EXP	AST_NAME_AVOGADRO (Level 3 only)
AST_FUNCTION_ABS	AST_FUNCTION_FACTORIAL	AST_NAME_TIME
AST_FUNCTION_ARCCOS	AST_FUNCTION_FLOOR	AST_PLUS
AST_FUNCTION_ARCCOSH	AST_FUNCTION_LN	AST_POWER
AST_FUNCTION_ARCCOT	AST_FUNCTION_LOG	AST_RATIONAL
AST_FUNCTION_ARCCOTH	AST_FUNCTION_PIECEWISE	AST_REAL
AST_FUNCTION_ARCCSC	AST_FUNCTION_POWER	AST_REAL_E
AST_FUNCTION_ARCCSCH	AST_FUNCTION_ROOT	AST_RELATIONAL_EQ
AST_FUNCTION_ARCSEC	AST_FUNCTION_SEC	AST_RELATIONAL_GEQ
AST_FUNCTION_ARCSECH	AST_FUNCTION_SECH	AST_RELATIONAL_GT
AST_FUNCTION_ARCSIN	AST_FUNCTION_SIN	AST_RELATIONAL_LEQ
AST_FUNCTION_ARCSINH	AST_FUNCTION_SINH	AST_RELATIONAL_LT
AST_FUNCTION_ARCTAN	AST_FUNCTION_TAN	AST_RELATIONAL_NEQ
AST_FUNCTION_ARCTANH	AST_FUNCTION_TANH	AST_TIMES
AST_FUNCTION_CEILING	AST_INTEGER	AST_UNKNOWN
AST_FUNCTION_COS	AST_LAMBDA
AST_FUNCTION_COSH	AST_LOGICAL_AND

The types have the following meanings:

• If the node is basic mathematical operator (e.g., "+"), then the node's type will be AST_PLUS, AST_MINUS, AST_TIMES, AST_DIVIDE, or AST_POWER, as appropriate.

• If the node is a predefined function or operator from SBML Level 1 (in the string-based formula syntax used in Level 1) or SBML Level 2 and 3 (in the subset of MathML used in SBML Levels 2 and 3), then the node's type will be either AST_FUNCTION_ X, AST_LOGICAL_ X, or AST_RELATIONAL_ X, as appropriate. (Examples: AST_FUNCTION_LOG, AST_RELATIONAL_LEQ.)

• If the node refers to a user-defined function, the node's type will be AST_FUNCTION (because it holds the name of the function).

• If the node is a lambda expression, its type will be AST_LAMBDA.

• If the node is a predefined constant ("ExponentialE", "Pi", "True" or "False"), then the node's type will be AST_CONSTANT_E, AST_CONSTANT_PI, AST_CONSTANT_TRUE, or AST_CONSTANT_FALSE.

• (Levels 2 and 3 only) If the node is the special MathML csymbol time, the value of the node will be AST_NAME_TIME. (Note, however, that the MathML csymbol delay is translated into a node of type AST_FUNCTION_DELAY. The difference is due to the fact that time is a single variable, whereas delay is actually a function taking arguments.)

• (Level 3 only) If the node is the special MathML csymbol avogadro, the value of the node will be AST_NAME_AVOGADRO.

• If the node contains a numerical value, its type will be AST_INTEGER, AST_REAL, AST_REAL_E, or AST_RATIONAL, as appropriate.