libSBML Perl API  libSBML 5.10.0 Perl API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
L3ParserSettings.h File Reference

Definition of the level 3 infix-to-mathml parser settings. More...

Include dependency graph for L3ParserSettings.h:
This graph shows which files directly or indirectly include this file:

Classes

class  L3ParserSettings
 {core} A helper class for controlling the behavior of the text-string formula parser. More...
 

Macros

#define L3P_AVOGADRO_IS_CSYMBOL   true
 
#define L3P_AVOGADRO_IS_NAME   false
 
#define L3P_COLLAPSE_UNARY_MINUS   true
 
#define L3P_EXPAND_UNARY_MINUS   false
 
#define L3P_NO_UNITS   false
 
#define L3P_PARSE_UNITS   true
 

Enumerations

enum  ParseLogType_t {
  L3P_PARSE_LOG_AS_LOG10 = 0,
  L3P_PARSE_LOG_AS_LN = 1,
  L3P_PARSE_LOG_AS_ERROR = 2
}
 Configuration values for handling log in formulas. More...
 

Detailed Description

Definition of the level 3 infix-to-mathml parser settings.

Author
Lucian Smith

Macro Definition Documentation

#define L3P_AVOGADRO_IS_CSYMBOL   true

Recognize 'avogadro' as an SBML Level 3 symbol.

See also
getParseAvogadroCsymbol()
setParseAvogadroCsymbol()
#define L3P_AVOGADRO_IS_NAME   false

Do not treat 'avogadro' specially—consider it a plain symbol name.

See also
getParseAvogadroCsymbol()
setParseAvogadroCsymbol()
#define L3P_COLLAPSE_UNARY_MINUS   true

Collapse unary minuses where possible.

See also
getParseCollapseMinus()
setParseCollapseMinus()
Examples:
translateL3Math.cpp.
#define L3P_EXPAND_UNARY_MINUS   false

Retain unary minuses in the AST representation.

See also
getParseCollapseMinus()
setParseCollapseMinus()
Examples:
translateL3Math.cpp.
#define L3P_NO_UNITS   false

Do not recognize units in text-string formulas—treat them as errors.

See also
setParseCollapseMinus()
getParseCollapseMinus()
#define L3P_PARSE_UNITS   true

Parse units in text-string formulas.

See also
setParseCollapseMinus()
getParseCollapseMinus()

Enumeration Type Documentation

Configuration values for handling log in formulas.

The L3ParserSettings object can be used to modify the SBML L3 parser to translate the function log(x) three different ways, each settable with this type enum.

See also
L3ParserSettings
Enumerator
L3P_PARSE_LOG_AS_LOG10 

Parse log(x) as the base-10 logarithm of x.

L3P_PARSE_LOG_AS_LN 

Parse log(x) as the natural logarithm of x.

L3P_PARSE_LOG_AS_ERROR 

Refuse to parse log(x) at all, and set an error message telling the user to use log10(x), ln(x), or log(base, x) instead.