Serialized Form

Package org.mariuszgromada.math.mxparser

Class org.mariuszgromada.math.mxparser.Argument extends PrimitiveElement implements Serializable

Serialized Fields

argumentBodyType

int argumentBodyType

Argument body type.

See Also:

Argument.BODY_RUNTIME, Argument.BODY_EXTENDED, Argument.getArgumentBodyType()

argumentExpression

Expression argumentExpression

Argument expression for dependent and recursive arguments.

argumentExtension

ArgumentExtension argumentExtension

Argument extension (body based in code)

See Also:

ArgumentExtension, Argument(String, ArgumentExtension)

argumentName

String argumentName

Argument name (x, y, arg1, my_argument, etc...)

argumentType

int argumentType

Argument type (free, dependent)

argumentValue

double argumentValue

Argument value (for free arguments).

description

String description

Description of the argument.

n

Argument n

Index argument.

See Also:

RecursiveArgument

Class org.mariuszgromada.math.mxparser.CalcStepRecord extends Object implements Serializable

Serialized Fields

content

String content

Calculation step content - so what is really happening in this step

description

String description

Calculation step description - can be ana argument name, function name and or an expression string

firstInGroup

boolean firstInGroup

True if this is a first step in a given group.

lastInGroup

boolean lastInGroup

True if this is a last step in a given group.

numberGroup

int numberGroup

If an expression makes a reference to a dependent argument or a user function then the calculation process will be done based on the calculation tree, where each group will be a marker of a particular (different) leaf of this tree.

numberGroupWithin

int numberGroupWithin

Marker of a step in a process of calculation of a given expression pointed by a particular leaf in a calculation tree.

type

CalcStepRecord.StepType type

Calculation step type

See Also:

CalcStepRecord.StepType

Class org.mariuszgromada.math.mxparser.CalcStepsRegister extends Object implements Serializable

Serialized Fields

argumentNameStart

String argumentNameStart

If a root of the calculation tree is an argument then argument name is provided here

calcStepRecords

List<CalcStepRecord> calcStepRecords

List that stores all the calculation steps

computingTime

double computingTime

Duration of calculation process - in seconds

errorMessage

String errorMessage

Information on error or lack of error while performing calculation process

expressionStringStart

String expressionStringStart

1. If a root of the calculation tree is an expression then expression string is provided here. 2. If a root of the calculation tree is an argument then argument expression string is provided here. 3. If a root of the calculation tree is a function then function expression string is provided here.

functionNameStart

String functionNameStart

If a root of the calculation tree is a function then function name is provided here

isStartSet

boolean isStartSet

result

double result

Final result of calculation

stepNumberGroup

int stepNumberGroup

stepType

CalcStepRecord.StepType stepType

Class org.mariuszgromada.math.mxparser.Constant extends PrimitiveElement implements Serializable

Serialized Fields

constantName

String constantName

Name of the constant

constantValue

double constantValue

COnstant value

description

String description

Constant description

errorMessage

String errorMessage

Message after checking the syntax

relatedExpressionsList

List<Expression> relatedExpressionsList

Dependent expression list

syntaxStatus

boolean syntaxStatus

Status of the expression syntax Please referet to the: - NO_SYNTAX_ERRORS - SYNTAX_ERROR_OR_STATUS_UNKNOWN

Class org.mariuszgromada.math.mxparser.Expression extends PrimitiveElement implements Serializable

Serialized Fields

ARGUMENT

String ARGUMENT

argumentsList

List<Argument> argumentsList

List of arguments

See Also:

Argument, RecursiveArgument

attemptToFixExpStrEnabled

boolean attemptToFixExpStrEnabled

Internal indicator informing the parser whether to try to fix the expression String. For example, situations such as: "++" change to "+", "+-" changed tro "-" "-+" changed tro "-" "--" changed tro "+"

computingTime

double computingTime

Keeps computing time

constantsList

List<Constant> constantsList

List of user defined constants

See Also:

Constant

description

String description

Expression description

disableRounding

boolean disableRounding

Internal parameter for calculus expressions to avoid decrease in accuracy.

ERROR

String ERROR

errorMessage

String errorMessage

Message after checking the syntax

expressionString

String expressionString

Expression string (for example: "sin(x)+cos(y)")

expressionStringCleaned

String expressionStringCleaned

Expression string after attempt to clean

expressionWasModified

boolean expressionWasModified

if true then new tokenizing is required (the initialTokens list needs to be updated)

FUNCTION

String FUNCTION

functionsList

List<Function> functionsList

List of user defined functions

See Also:

Function

impliedMultiplicationError

boolean impliedMultiplicationError

Fires an error when impliedMultiplicationMode is on and there is a missing multiplication operator

impliedMultiplicationMode

boolean impliedMultiplicationMode

Implied multiplication mode

initialTokens

List<Token> initialTokens

List of expression tokens (words). Token class defines all needed attributes for recognizing the structure of arithmetic expression. This is the key result when initial parsing is finished (tokenizeExpressionString() - method). Token keeps information about: - token type (for example: function, operator, argument, number, etc...) - token identifier within given type (sin, cos, operaotr, etc...) - token value (if token is a number) - token level - key information regarding sequence (order) of further parsing

internalClone

boolean internalClone

Internal indicator for calculation process Expression.Calculate() method It shows whether to build again tokens list if clone - build again if not clone - build only at the beginning Indicator helps to solve the problem with above definitions Function f = new Function("f(x) = 2*g(x)"); Function g = new Function("g(x) = 2*f(x)"); f.addDefinitions(g); g.addDefinitions(f);

keyWordsList

List<KeyWord> keyWordsList

List of key words known by the parser

neverParseForImpliedMultiplication

Set<String> neverParseForImpliedMultiplication

List of string tokens that should not be considered while seeking for optional implied multiplication. Example: sum( x2y, 1, 10, 2*x2y) Here x2y should always stay as x2y

optionsChangesetNumber

int optionsChangesetNumber

mXparser options changeset used in checkSyntax() method

parserKeyWordsOnly

boolean parserKeyWordsOnly

Internal indicator for tokenization process if true, then keywords such as constants functions etc... will not be recognized during tokenization

recursionCallPending

boolean recursionCallPending

Log used internally to mark started recursion call on the current object, necessary to avoid infinite loops while recursive syntax checking (i.e. f to g and g to f) or marking modified flags on the expressions related to this expression.

See Also:

Expression.setExpressionModifiedFlag(), Expression.checkSyntax()

recursionCallsCounter

int recursionCallsCounter

Internal counter to avoid infinite loops while calculating expression defined in the way shown by below examples Argument x = new Argument("x = 2*y"); Argument y = new Argument("y = 2*x"); x.addDefinitions(y); y.addDefinitions(x); Function f = new Function("f(x) = 2*g(x)"); Function g = new Function("g(x) = 2*f(x)"); f.addDefinitions(g); g.addDefinitions(f);

recursiveMode

boolean recursiveMode

If recursive mode is on the recursive calls are permitted. It means there will be no null pointer exceptions due to expression, and functions cloning.

relatedExpressionsList

List<Expression> relatedExpressionsList

List of related expressions, for example when user defined function is used in the expression or dependent argument was defined. Modification of function expression calls the method expression modified flag method to all related expressions. Related expression usually are used for - dependent arguments - recursive arguments - user functions

syntaxStatus

boolean syntaxStatus

Status of the expression syntax Please referet to the: - NO_SYNTAX_ERRORS - SYNTAX_ERROR_OR_STATUS_UNKNOWN

tokensList

List<Token> tokensList

the initialTokens list keeps unchanged information about found tokens. While parsing the tokensList is used. The tokensList is the same as initialTokens list at the beginning of the calculation process. Each math operation changes tokens list - it means that tokens are parameters when performing math operation and the result is also presented as token (usually as a number token) At the end of the calculation the tokensList should contain only one element - the result of all calculations.

UDFExpression

boolean UDFExpression

Indicator whether expression was automatically built for user defined functions purpose

See Also:

Function

UDFVariadicParamsAtRunTime

List<Double> UDFVariadicParamsAtRunTime

List of parameters provided by the user at run-time

See Also:

Function

unicodeKeyWordsEnabled

boolean unicodeKeyWordsEnabled

Internal indicator informing hte parser that unicode know keywords are enabled and will be recognized by the parser as built-in functions or operators

UNITCONST

String UNITCONST

verboseMode

boolean verboseMode

Verbose mode prints processing info calls System.out.print* methods

Class org.mariuszgromada.math.mxparser.Function extends PrimitiveElement implements Serializable

Serialized Fields

description

String description

function description

functionBodyType

int functionBodyType

Function body type.

See Also:

Function.BODY_RUNTIME, Function.BODY_EXTENDED, Function.getFunctionBodyType()

functionExpression

Expression functionExpression

function expression

functionExtension

FunctionExtension functionExtension

Function extension (body based in code)

See Also:

FunctionExtension, FunctionExtensionVariadic, Function(String, FunctionExtension)

functionExtensionVariadic

FunctionExtensionVariadic functionExtensionVariadic

Function extension variadic (body based in code)

See Also:

FunctionExtension, FunctionExtensionVariadic, Function(String, FunctionExtension)

functionName

String functionName

function name

isVariadic

boolean isVariadic

Indicates whether UDF is variadic

parametersNumber

int parametersNumber

The number of function parameters

Class org.mariuszgromada.math.mxparser.PrimitiveElement extends Object implements Serializable

Serialized Fields

myTypeId

int myTypeId

Element type id

See Also:

Argument.TYPE_ID, Constant.TYPE_ID, Function.TYPE_ID

Class org.mariuszgromada.math.mxparser.RecursiveArgument extends Argument implements Serializable

Serialized Fields

baseValues

List<Double> baseValues

Base values

recursiveCounter

int recursiveCounter

To avoid never ending loops

startingIndex

int startingIndex

Package org.mariuszgromada.math.mxparser.parsertokens

Class org.mariuszgromada.math.mxparser.parsertokens.KeyWord extends Object implements Serializable

Serialized Fields

description

String description

since

String since

syntax

String syntax

wordId

int wordId

wordString

String wordString

wordTypeId

int wordTypeId

Class org.mariuszgromada.math.mxparser.parsertokens.Token extends Object implements Serializable

Serialized Fields

keyWord

String keyWord

Key word string (if matched)

looksLike

String looksLike

If token was not matched then looksLike functionality is trying asses the kind of token

tokenId

int tokenId

Token identifier

tokenLevel

int tokenLevel

Token level

tokenStr

String tokenStr

String token

tokenTypeId

int tokenTypeId

Token type

tokenValue

double tokenValue

Token value if number