/usr/include/sbml/math/ASTTypes.h is in libsbml5-dev 5.16.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | /**
* @file ASTTypes.h
* @brief Abstract Syntax Tree (AST) class types.
* @author Sarah Keating
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2017 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2012 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution and
* also available online as http://sbml.org/software/libsbml/license.html
* ------------------------------------------------------------------------ -->
*/
#ifndef ASTTypes_h
#define ASTTypes_h
#include <sbml/common/extern.h>
LIBSBML_CPP_NAMESPACE_BEGIN
/**
* @enum ASTNodeType_t
* @brief ASTNodeType_t is the enumeration of possible
* @if conly ASTNode_t @else ASTNode @endif types.
*
* @copydetails doc_astnode_types
*
* @see @if conly ASTNode_getType() @else ASTNode::getType() @endif
* @see @if conly ASTNode_canonicalize() @else ASTNode::canonicalize() @endif
*
* @if conly
* @memberof ASTNode_t
* @endif
*/
typedef enum
{
AST_PLUS = 43 /*!< Plus (MathML <code><plus></code>) */
, AST_MINUS = 45 /*!< Minus (MathML <code><minus></code>) */
, AST_TIMES = 42 /*!< Times (MathML <code><times></code>) */
, AST_DIVIDE = 47 /*!< Divide (MathML <code><divide></code>) */
, AST_POWER = 94 /*!< Power (MathML <code><power></code>) */
, AST_INTEGER = 256 /*!< Integer (MathML <code><cn type="integer"></code>) */
, AST_REAL /*!< Real (MathML <code><cn></code>) */
, AST_REAL_E /*!< Real number with e-notation (MathML <code><cn type="e-notation"> [number] <sep/> [number] </cn></code>) */
, AST_RATIONAL /*!< Rational (MathML <code><cn type="rational"> [number] <sep/> [number] <cn></code>) */
, AST_NAME /*!< A named node (MathML <code><ci></code>) */
, AST_NAME_AVOGADRO /*!< Avogadro (MathML <code><ci encoding="text" definitionURL="http://www.sbml.org/sbml/symbols/avogadro"></code>) */
, AST_NAME_TIME /*!< Time (MathML <code><ci encoding="text" definitionURL="http://www.sbml.org/sbml/symbols/time"></code>) */
, AST_CONSTANT_E /*!< Exponential E (MathML <code><exponentiale></code>) */
, AST_CONSTANT_FALSE /*!< False (MathML <code><false></code>) */
, AST_CONSTANT_PI /*!< Pi (MathML <code><pi></code>) */
, AST_CONSTANT_TRUE /*!< True (MathML <code><true></code>) */
, AST_LAMBDA /*!< Lambda (MathML <code><lambda></code>) */
, AST_FUNCTION /*!< User-defined function (MathML <code><apply></code>) */
, AST_FUNCTION_ABS /*!< Absolute value (MathML <code><abs></code>) */
, AST_FUNCTION_ARCCOS /*!< Arccosine (MathML <code><arccos></code>) */
, AST_FUNCTION_ARCCOSH /*!< Hyperbolic arccosine (MathML <code><arccosh></code>) */
, AST_FUNCTION_ARCCOT /*!< Arccotangent (MathML <code><arccot></code>) */
, AST_FUNCTION_ARCCOTH /*!< Hyperbolic arccotangent (MathML <code><arccoth></code>) */
, AST_FUNCTION_ARCCSC /*!< Arccosecant (MathML <code><arccsc></code>) */
, AST_FUNCTION_ARCCSCH /*!< Hyperbolic arccosecant (MathML <code><arccsch></code>) */
, AST_FUNCTION_ARCSEC /*!< Arcsecant (MathML <code><arcsec></code>) */
, AST_FUNCTION_ARCSECH /*!< Hyperbolic arcsecant (MathML <code><arcsech></code>) */
, AST_FUNCTION_ARCSIN /*!< Arcsine (MathML <code><arcsin></code>) */
, AST_FUNCTION_ARCSINH /*!< Hyperbolic arcsine (MathML <code><arcsinh></code>) */
, AST_FUNCTION_ARCTAN /*!< Arctangent (MathML <code><arctan></code>) */
, AST_FUNCTION_ARCTANH /*!< Hyperbolic arctangent (MathML <code><arctanh></code>) */
, AST_FUNCTION_CEILING /*!< Ceiling (MathML <code><ceiling></code>) */
, AST_FUNCTION_COS /*!< Cosine (MathML <code><cosine></code>) */
, AST_FUNCTION_COSH /*!< Hyperbolic cosine (MathML <code><cosh></code>) */
, AST_FUNCTION_COT /*!< Cotangent (MathML <code><cot></code>) */
, AST_FUNCTION_COTH /*!< Hyperbolic cotangent (MathML <code><coth></code>) */
, AST_FUNCTION_CSC /*!< Cosecant (MathML <code><csc></code>) */
, AST_FUNCTION_CSCH /*!< Hyperbolic cosecant (MathML <code><csch></code>) */
, AST_FUNCTION_DELAY /*!< %Delay (MathML <code><csymbol encoding="text" definitionURL="http://www.sbml.org/sbml/symbols/delay"></code>) */
, AST_FUNCTION_EXP /*!< Exponential (MathML <code><exp></code>) */
, AST_FUNCTION_FACTORIAL /*!< Factorial (MathML <code><factorial></code>) */
, AST_FUNCTION_FLOOR /*!< Floor (MathML <code><floor></code>) */
, AST_FUNCTION_LN /*!< Natural Log (MathML <code><ln></code>) */
, AST_FUNCTION_LOG /*!< Log (MathML <code><log></code>) */
, AST_FUNCTION_PIECEWISE /*!< Piecewise (MathML <code><piecewise></code>) */
, AST_FUNCTION_POWER /*!< Power (MathML <code><power></code>) */
, AST_FUNCTION_ROOT /*!< Root (MathML <code><root></code>) */
, AST_FUNCTION_SEC /*!< Secant (MathML <code><sec></code>) */
, AST_FUNCTION_SECH /*!< Hyperbolic secant (MathML <code><sech></code>) */
, AST_FUNCTION_SIN /*!< Sine (MathML <code><sin></code>) */
, AST_FUNCTION_SINH /*!< Hyperbolic sine (MathML <code><sinh></code>) */
, AST_FUNCTION_TAN /*!< Tangent (MathML <code><tan></code>) */
, AST_FUNCTION_TANH /*!< Hyperbolic tangent (MathML <code><tanh></code>) */
, AST_LOGICAL_AND /*!< Logical and (MathML <code><and></code>) */
, AST_LOGICAL_NOT /*!< Logical not (MathML <code><not></code>) */
, AST_LOGICAL_OR /*!< Logical or (MathML <code><or></code>) */
, AST_LOGICAL_XOR /*!< Logical exclusive or (MathML <code><xor></code>) */
, AST_RELATIONAL_EQ /*!< Equal (MathML <code><eq></code>) */
, AST_RELATIONAL_GEQ /*!< Greater than or equal (MathML <code><geq></code>) */
, AST_RELATIONAL_GT /*!< Greater than (MathML <code><gt></code>) */
, AST_RELATIONAL_LEQ /*!< Less than or equal (MathML <code><leq></code>) */
, AST_RELATIONAL_LT /*!< Less than (MathML <code><lt></code>) */
, AST_RELATIONAL_NEQ /*!< Not equal (MathML <code><neq></code>) */
, AST_QUALIFIER_BVAR/*!< Bvar qualifier (MathML <code><bvar></code>) */
, AST_QUALIFIER_LOGBASE/*!< Logbase qualifier (MathML <code><logbase></code>) */
, AST_QUALIFIER_DEGREE/*!< Degree qualifier (MathML <code><degree></code>) */
, AST_SEMANTICS/*!< Semantics (MathML <code><semantics></code>) */
, AST_CONSTRUCTOR_PIECE/*!< Piece constructor (MathML <code><piece></code>) */
, AST_CONSTRUCTOR_OTHERWISE/*!< Otherwise constructor (MathML <code><otherwise></code>) */
/* L3V2 */
, AST_FUNCTION_MAX /*!< Max (MathML <code><max></code>) */
, AST_FUNCTION_MIN /*!< Min (MathML <code><min></code>) */
, AST_FUNCTION_QUOTIENT /*!< Quotient (MathML <code><quotient></code>) */
, AST_FUNCTION_RATE_OF /*!< Derivative with respect to time (MathML <code><ci encoding="text" definitionURL="http://www.sbml.org/sbml/symbols/rateOf"></code>) */
, AST_FUNCTION_REM /*!< Rem (MathML <code><rem></code>) */
, AST_LOGICAL_IMPLIES /*!< Implies (MathML <code><implies></code>) */
, AST_CSYMBOL_FUNCTION = 400
, AST_UNKNOWN /*!< Unknown node: will not produce any MathML */
, AST_ORIGINATES_IN_PACKAGE /*!< This node uses math that is only available in an L3 package */
} ASTNodeType_t;
/** @cond doxygenLibsbmlInternal */
typedef enum
{
AST_TYPECODE_BASE
, AST_TYPECODE_CN_BASE
, AST_TYPECODE_FUNCTION_BASE
, AST_TYPECODE_NUMBER
, AST_TYPECODE_CN_INTEGER
, AST_TYPECODE_CN_EXPONENTIAL
, AST_TYPECODE_CN_RATIONAL
, AST_TYPECODE_CN_REAL
, AST_TYPECODE_CONSTANT_NUMBER
, AST_TYPECODE_CI_NUMBER
, AST_TYPECODE_CSYMBOL
, AST_TYPECODE_CSYMBOL_AVOGADRO
, AST_TYPECODE_CSYMBOL_DELAY
, AST_TYPECODE_CSYMBOL_TIME
, AST_TYPECODE_CSYMBOL_RATE_OF
, AST_TYPECODE_FUNCTION
, AST_TYPECODE_FUNCTION_UNARY
, AST_TYPECODE_FUNCTION_BINARY
, AST_TYPECODE_FUNCTION_NARY
, AST_TYPECODE_FUNCTION_PIECEWISE
, AST_TYPECODE_FUNCTION_LAMBDA
, AST_TYPECODE_FUNCTION_CI
, AST_TYPECODE_FUNCTION_SEMANTIC
, AST_TYPECODE_FUNCTION_QUALIFIER
, AST_TYPECODE_ASTNODE
} AST_Class_TypeCode_t;
/** @endcond */
LIBSBML_CPP_NAMESPACE_END
/** @cond doxygenLibsbmlInternal */
#ifdef __cplusplus
#include <string>
LIBSBML_CPP_NAMESPACE_BEGIN
class ASTBasePlugin;
/**
* Note to developers: leave at least one comment here. Without it, something
* doesn't go right when docs are generated.
*/
LIBSBML_EXTERN
bool representsNumber(int type);
LIBSBML_EXTERN
bool representsFunction(int type, ASTBasePlugin* plugin = NULL);
LIBSBML_EXTERN
bool representsUnaryFunction(int type, ASTBasePlugin* plugin = NULL);
LIBSBML_EXTERN
bool representsBinaryFunction(int type, ASTBasePlugin* plugin = NULL);
LIBSBML_EXTERN
bool representsNaryFunction(int type, ASTBasePlugin* plugin = NULL);
LIBSBML_EXTERN
bool representsQualifier(int type, ASTBasePlugin* plugin = NULL);
LIBSBML_EXTERN
bool representsFunctionRequiringAtLeastTwoArguments(int type);
LIBSBML_EXTERN
int getCoreTypeFromName(const std::string& name);
LIBSBML_EXTERN
const char* getNameFromCoreType(int type);
LIBSBML_EXTERN
bool isCoreTopLevelMathMLFunctionNodeTag(const std::string& name);
LIBSBML_EXTERN
bool isCoreTopLevelMathMLNumberNodeTag(const std::string& name);
LIBSBML_CPP_NAMESPACE_END
#endif /* cplusplus */
/** @endcond */
#endif /* ASTTypes_h */
|