org.matheclipse.core.interfaces

Interface ISymbol

All Superinterfaces:

edu.jas.structure.AbelianGroupElem<IExpr>, java.lang.Comparable<IExpr>, edu.jas.structure.Element<IExpr>, org.apache.commons.math4.FieldElement<IExpr>, edu.jas.structure.GcdRingElem<IExpr>, IExpr, edu.jas.structure.MonoidElem<IExpr>, edu.jas.structure.RingElem<IExpr>, java.io.Serializable

All Known Implementing Classes:

MethodSymbol, Symbol

public interface ISymbol
extends IExpr

An expression representing a symbol (i.e. variable- constant- or function-name)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ISymbol.RuleType

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSOLE_OUTPUT ISymbol attribute to indicate that a symbols evaluation should be printed to Console with System.out.println();
static int	CONSTANT ISymbol attribute to indicate that a symbol has a constant value
static int	DELAYED_RULE_EVALUATION ISymbol attribute to indicate that a symbols evaluation should be printed to Console with System.out.println();
static int	FLAT ISymbol attribute for an associative function transformation.
static int	FLATORDERLESS ISymbol attribute combination (ISymbol.FLAT and ISymbol.ORDERLESS)
static int	HOLDALL ISymbol attribute for a function, where no argument should be evaluated
static int	HOLDFIRST ISymbol attribute for a function, where the first argument should not be evaluated
static int	HOLDREST ISymbol attribute for a function, where only the first argument should be evaluated
static int	LISTABLE ISymbol attribute for a function with lists as arguments
static int	NHOLDALL ISymbol attribute for a function, which should not be evaluated numerically
static int	NHOLDFIRST ISymbol attribute for a function, where the first argument should not be evaluated numerically
static int	NHOLDREST ISymbol attribute for a function, where the rest of the arguments should not be evaluated numerically.
static int	NOATTRIBUTE ISymbol attribute which means that no attribute is set.
static int	NUMERICFUNCTION ISymbol attribute for a numeric function
static int	ONEIDENTITY ISymbol attribute for a function transformation: f(x) ==> x
static int	ORDERLESS ISymbol attribute for a commutative function transformation.
static int	PACKAGE_LOADED ISymbol flag for a symbol which has already loaded it's package definition

Fields inherited from interface org.matheclipse.core.interfaces.IExpr

ASTID, BLANKID, COMPLEXID, DOUBLECOMPLEXID, DOUBLEID, FRACTIONID, INTEGERID, METHODSYMBOLID, PATTERNID, STRINGID, SYMBOLID

Method Summary

Modifier and Type	Method and Description
void	clear(EvalEngine engine) Clear the associated rules for this symbol
void	clearAll(EvalEngine engine) Clear all associated rules and attributes for this symbol
boolean	containsRules() Check if ths symbol contains a "DownRule" or "UpRule"
void	createRulesData(int[] sizes) Create internal rules data structure with precalculated sizes index 0 - number of equal rules in RULES
java.util.List<IAST>	definition() Return a list of the rules associated to this symbol
java.lang.String	definitionToString() Return the rules associated to this symbol in String representation
IExpr	evalDownRule(IEvaluationEngine engine, IExpr expression) Evaluate the given expression for the "down value" rules associated with this symbol
IExpr	evalUpRule(IEvaluationEngine engine, IExpr expression) Evaluate the given expression for the "up value" rules associated with this symbol
IExpr	get() Get the topmost value from the local variable stack
IExpr	getAssignedValue() Get the value which is assigned to the symbol or null, if no value is assigned.
int	getAttributes() Get the Attributes of this symbol (i.e.
IExpr	getDefaultValue() Get the general default value for this symbol (i.e.
IExpr	getDefaultValue(int position) Get the default value at the arguments position for this symbol (i.e.
IEvaluator	getEvaluator() Get the current evaluator for this symbol
RulesData	getRulesData()
java.lang.String	getSymbolName() Get the pure symbol name string
boolean	hasAssignedSymbolValue() Is a (local or global) value assigned for this symbol?
boolean	hasLocalVariableStack() Is a local variable stack created for this symbol ?
boolean	isString(java.lang.String symbolName) Tests if this symbols name equals the given string
boolean	isSymbolName(java.lang.String name) Returns true, if this symbol has the given name.
IExpr	mapConstantDouble(INumericFunction<IExpr> function) If this symbol has attribute ISymbol.CONSTANT and the symbol's evaluator is of instance INumericConstant, then apply the constants double value to the given function and return the result, otherwise return F.NIL.
void	popLocalVariable() Delete the topmost placeholder from the local variable stack
void	pushLocalVariable() Create a new variable placeholder on the symbols variable stack
void	pushLocalVariable(IExpr localValue) Create a new variable placeholder on the symbols variable stack and set the local value
IPatternMatcher	putDownRule(ISymbol.RuleType setSymbol, boolean equalRule, IExpr leftHandSide, IExpr rightHandSide, boolean packageMode) Associate a new "down value" rule with default priority to this symbol.
IPatternMatcher	putDownRule(ISymbol.RuleType setSymbol, boolean equalRule, IExpr leftHandSide, IExpr rightHandSide, int priority, boolean packageMode) Associate a new rule with the given priority to this symbol.
IPatternMatcher	putDownRule(PatternMatcherAndInvoker pmEvaluator) Associate a new rule, which invokes a method, to this symbol.
IPatternMatcher	putUpRule(ISymbol.RuleType setSymbol, boolean equalRule, IAST leftHandSide, IExpr rightHandSide) Associate a new "up value" rule with default priority to this symbol.
IPatternMatcher	putUpRule(ISymbol.RuleType setSymbol, boolean equalRule, IAST leftHandSide, IExpr rightHandSide, int priority) Associate a new "up value" rule with the given priority to this symbol.
void	readRules(java.io.ObjectInputStream stream) Deserialize the rules associated to this object
IExpr[]	reassignSymbolValue(java.util.function.Function<IExpr,IExpr> function, ISymbol functionSymbol) Apply the function to the currently assigned value of the symbol and reassign the result value to the symbol.
void	removeRule(ISymbol.RuleType setSymbol, boolean equalRule, IExpr leftHandSide, boolean packageMode)
void	set(IExpr value) Set the value of the local variable on top of the local variable stack
void	setAttributes(int attributes) Set the Attributes of this symbol (i.e.
void	setDefaultValue(IExpr expr) Set the general default value for this symbol (i.e.
void	setDefaultValue(int position, IExpr expr) Set the default value at the arguments position for this symbol (i.e.
void	setEvaluator(IEvaluator module) Set the current evaluator which is associated to this symbol
boolean	writeRules(java.io.ObjectOutputStream stream) Serialize the rule definitions associated to this symbol

Methods inherited from interface org.matheclipse.core.interfaces.IExpr

$div, $minus, $plus, $times, $up, accept, accept, accept, accept, and, apply, apply, asType, compareTo, dec, divide, evalComplex, evalDouble, evalNumber, evalSignedNumber, evaluate, evaluateHead, fullFormString, getAt, getField, head, hierarchy, ifPresent, inc, internalFormString, internalJavaString, internalScalaString, inverse, isAllExpanded, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isBlank, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isConstant, isCos, isCosh, isDerivative, isDirectedInfinity, isE, isExpanded, isFalse, isFlatAST, isFraction, isFree, isFree, isFree, isFreeAST, isFreeAST, isFreeOfPatterns, isFunction, isGEOrdered, isGTOrdered, isIndeterminate, isInfinity, isInteger, isIntegerResult, isLEOrdered, isList, isListOfLists, isLog, isLTOrdered, isMatrix, isMember, isMember, isMinusOne, isModule, isNegative, isNegativeInfinity, isNegativeResult, isNonNegativeResult, isNot, isNumber, isNumEqualInteger, isNumEqualRational, isNumeric, isNumericFunction, isNumericMode, isNumIntValue, isOne, isONE, isOr, isOrderlessAST, isPattern, isPatternDefault, isPatternExpr, isPatternSequence, isPi, isPlus, isPlusTimesPower, isPolynomial, isPolynomial, isPolynomialOfMaxDegree, isPositive, isPositiveResult, isPower, isPresent, isRational, isRationalResult, isRationalValue, isRealResult, isRuleAST, isSame, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSpan, isSymbol, isTan, isTanh, isTimes, isTrue, isUnit, isValue, isVariable, isVector, isZero, isZERO, leafCount, leaves, minus, mod, multiply, multiply, negative, ofNullable, opposite, optional, or, orElse, orElseGet, orElseThrow, plus, power, power, reciprocal, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceSlots, signum, subtract, sum, times, timesDistributed, topHead, variables2Slots

Methods inherited from interface edu.jas.structure.RingElem

egcd, gcd

Methods inherited from interface edu.jas.structure.AbelianGroupElem

abs, negate

Methods inherited from interface edu.jas.structure.MonoidElem

remainder

Methods inherited from interface edu.jas.structure.Element

copy, equals, factory, hashCode, toScript, toScriptFactory

Methods inherited from interface org.apache.commons.math4.FieldElement

negate

Field Detail

CONSOLE_OUTPUT

static final int CONSOLE_OUTPUT

ISymbol attribute to indicate that a symbols evaluation should be printed to Console with System.out.println();

See Also:

Constant Field Values

CONSTANT

static final int CONSTANT

ISymbol attribute to indicate that a symbol has a constant value

See Also:

Constant Field Values

FLAT

static final int FLAT

ISymbol attribute for an associative function transformation. The evaluation of the function will flatten the arguments list

See Also:

Constant Field Values

HOLDFIRST

static final int HOLDFIRST

ISymbol attribute for a function, where the first argument should not be evaluated

See Also:

Constant Field Values

HOLDREST

static final int HOLDREST

ISymbol attribute for a function, where only the first argument should be evaluated

See Also:

Constant Field Values

HOLDALL

static final int HOLDALL

ISymbol attribute for a function, where no argument should be evaluated

See Also:

Constant Field Values

LISTABLE

static final int LISTABLE

ISymbol attribute for a function with lists as arguments

See Also:

Constant Field Values

NHOLDFIRST

static final int NHOLDFIRST

ISymbol attribute for a function, where the first argument should not be evaluated numerically

See Also:

Constant Field Values

NHOLDREST

static final int NHOLDREST

ISymbol attribute for a function, where the rest of the arguments should not be evaluated numerically.

See Also:

Constant Field Values

NHOLDALL

static final int NHOLDALL

ISymbol attribute for a function, which should not be evaluated numerically

See Also:

Constant Field Values

NOATTRIBUTE

static final int NOATTRIBUTE

ISymbol attribute which means that no attribute is set.

See Also:

Constant Field Values

NUMERICFUNCTION

static final int NUMERICFUNCTION

ISymbol attribute for a numeric function

See Also:

Constant Field Values

PACKAGE_LOADED

static final int PACKAGE_LOADED

ISymbol flag for a symbol which has already loaded it's package definition

See Also:

Constant Field Values

ONEIDENTITY

static final int ONEIDENTITY

ISymbol attribute for a function transformation: f(x) ==> x

See Also:

Constant Field Values

ORDERLESS

static final int ORDERLESS

ISymbol attribute for a commutative function transformation. The evaluation of the function will sort the arguments.

See Also:

Constant Field Values

FLATORDERLESS

static final int FLATORDERLESS

ISymbol attribute combination (ISymbol.FLAT and ISymbol.ORDERLESS)

See Also:

Constant Field Values

DELAYED_RULE_EVALUATION

static final int DELAYED_RULE_EVALUATION

ISymbol attribute to indicate that a symbols evaluation should be printed to Console with System.out.println();

See Also:

Constant Field Values

Method Detail

getEvaluator

IEvaluator getEvaluator()

Get the current evaluator for this symbol

Returns:

the evaluator which is associated to this symbol or null if no evaluator is associated

getRulesData

RulesData getRulesData()

Returns:

null if no rules are defined

getSymbolName

java.lang.String getSymbolName()

Get the pure symbol name string

Returns:

setEvaluator

void setEvaluator(IEvaluator module)

Set the current evaluator which is associated to this symbol

isString

boolean isString(java.lang.String symbolName)

Tests if this symbols name equals the given string

Parameters:

symbolName -

Returns:

isSymbolName

boolean isSymbolName(java.lang.String name)

Returns true, if this symbol has the given name. The comparison of the symbols name with the given name is done according to the Config.PARSER_USE_LOWERCASE_SYMBOLS setting.

mapConstantDouble

IExpr mapConstantDouble(INumericFunction<IExpr> function)

If this symbol has attribute ISymbol.CONSTANT and the symbol's evaluator is of instance INumericConstant, then apply the constants double value to the given function and return the result, otherwise return F.NIL.

Parameters:

function - applys the function to a double value, resulting in an object of type IExpr.

Returns:

the resulting expression from the function or F.NIL.

See Also:

Abs, Ceiling, Floor

getAttributes

int getAttributes()

Get the Attributes of this symbol (i.e. LISTABLE, FLAT, ORDERLESS,...)

Returns:

See Also:

FLAT

setAttributes

void setAttributes(int attributes)

Set the Attributes of this symbol (i.e. LISTABLE, FLAT, ORDERLESS,...)

Parameters:

attributes - the Attributes of this symbol

pushLocalVariable

void pushLocalVariable()

Create a new variable placeholder on the symbols variable stack

pushLocalVariable

void pushLocalVariable(IExpr localValue)

Create a new variable placeholder on the symbols variable stack and set the local value

popLocalVariable

void popLocalVariable()

Delete the topmost placeholder from the local variable stack

hasAssignedSymbolValue

boolean hasAssignedSymbolValue()

Is a (local or global) value assigned for this symbol?

Returns:

true if this symbol has an assigned value.

hasLocalVariableStack

boolean hasLocalVariableStack()

Is a local variable stack created for this symbol ?

Returns:

true if this symbol has a local variable stack

get

IExpr get()

Get the topmost value from the local variable stack

Returns:

null if no local variable is defined

set

void set(IExpr value)

Set the value of the local variable on top of the local variable stack

putDownRule

IPatternMatcher putDownRule(ISymbol.RuleType setSymbol,
                            boolean equalRule,
                            IExpr leftHandSide,
                            IExpr rightHandSide,
                            boolean packageMode)

Associate a new "down value" rule with default priority to this symbol.

Parameters:

setSymbol - which of the symbols Set, SetDelayed, UpSet, UpSetDelayed was used for defining this rule

equalRule - true if the leftHandSide could be matched with equality

leftHandSide -

rightHandSide -

packageMode - true if we are on "package mode"

Returns:

See Also:

PatternMap.DEFAULT_RULE_PRIORITY

putDownRule

IPatternMatcher putDownRule(ISymbol.RuleType setSymbol,
                            boolean equalRule,
                            IExpr leftHandSide,
                            IExpr rightHandSide,
                            int priority,
                            boolean packageMode)

Associate a new rule with the given priority to this symbol.
Rules with lower numbers have higher priorities.

Parameters:

setSymbol - which of the symbols Set, SetDelayed, UpSet, UpSetDelayed was used for defining this rule

equalRule - true if the leftHandSide could be matched with equality

leftHandSide -

rightHandSide -

priority - the priority of the rule

packageMode - true if we are on "package mode"

Returns:

See Also:

PatternMap.DEFAULT_RULE_PRIORITY

putDownRule

IPatternMatcher putDownRule(PatternMatcherAndInvoker pmEvaluator)

Associate a new rule, which invokes a method, to this symbol.

putUpRule

IPatternMatcher putUpRule(ISymbol.RuleType setSymbol,
                          boolean equalRule,
                          IAST leftHandSide,
                          IExpr rightHandSide)

Associate a new "up value" rule with default priority to this symbol.

Parameters:

setSymbol - which of the symbols Set, SetDelayed, UpSet, UpSetDelayed was used for defining this rule

equalRule - true if the leftHandSide could be matched with equality

leftHandSide -

rightHandSide -

Returns:

See Also:

PatternMap.DEFAULT_RULE_PRIORITY

putUpRule

IPatternMatcher putUpRule(ISymbol.RuleType setSymbol,
                          boolean equalRule,
                          IAST leftHandSide,
                          IExpr rightHandSide,
                          int priority)

Associate a new "up value" rule with the given priority to this symbol.
Rules with lower numbers have higher priorities.

Parameters:

setSymbol - which of the symbols Set, SetDelayed, UpSet, UpSetDelayed was used for defining this rule

equalRule - true if the leftHandSide could be matched with equality

leftHandSide -

rightHandSide -

priority - the priority of the rule

Returns:

See Also:

PatternMap.DEFAULT_RULE_PRIORITY

removeRule

void removeRule(ISymbol.RuleType setSymbol,
                boolean equalRule,
                IExpr leftHandSide,
                boolean packageMode)

evalDownRule

IExpr evalDownRule(IEvaluationEngine engine,
                   IExpr expression)

Evaluate the given expression for the "down value" rules associated with this symbol

Parameters:

engine -

expression -

Returns:

F.NIL if no evaluation was possible

evalUpRule

IExpr evalUpRule(IEvaluationEngine engine,
                 IExpr expression)

Evaluate the given expression for the "up value" rules associated with this symbol

Parameters:

engine -

expression -

Returns:

F.NIL if no evaluation was possible

getDefaultValue

IExpr getDefaultValue()

Get the general default value for this symbol (i.e. 1 is the default value for Times, 0 is the default value for Plus). The general default value is used in pattern-matching for expressions like a_. * b_. + c_

Returns:

the default value or null if undefined.

getDefaultValue

IExpr getDefaultValue(int position)

Get the default value at the arguments position for this symbol (i.e. 1 is the default value for Power at position 2). The default value is used in pattern-matching for expressions like a ^ b_.

Parameters:

position - the position for the default value

Returns:

the default value or null if undefined.

setDefaultValue

void setDefaultValue(IExpr expr)

Set the general default value for this symbol (i.e. 1 is the default value for Times, 0 is the default value for Plus). The general default value is used in pattern-matching for expressions like a_. * b_. + c_

Parameters:

expr - the general default value

See Also:

getDefaultValue()

setDefaultValue

void setDefaultValue(int position,
                     IExpr expr)

Set the default value at the arguments position for this symbol (i.e. 1 is the default value for Power at position 2). The default value is used in pattern-matching for expressions like a ^ b_.

Parameters:

position - the position for the default value

expr - the default value for the given position

See Also:

getDefaultValue(int)

getAssignedValue

IExpr getAssignedValue()

Get the value which is assigned to the symbol or null, if no value is assigned.

Returns:

null, if no value is assigned.

reassignSymbolValue

IExpr[] reassignSymbolValue(java.util.function.Function<IExpr,IExpr> function,
                            ISymbol functionSymbol)

Apply the function to the currently assigned value of the symbol and reassign the result value to the symbol. Used for functions like AppendTo, Decrement, Increment,...

Parameters:

function - the function which should be applied

functionSymbol - if this method throws a WrongArgumentType exception the symbol will be displayed in the exceptions message

Returns:

an array with the currently assigned value of the symbol and the new calculated value of the symbol or null if the reassignment isn't possible.

See Also:

WrongArgumentType

clear

void clear(EvalEngine engine)

Clear the associated rules for this symbol

clearAll

void clearAll(EvalEngine engine)

Clear all associated rules and attributes for this symbol

containsRules

boolean containsRules()

Check if ths symbol contains a "DownRule" or "UpRule"

Returns:

true if this symbol contains a "DownRule" or "UpRule"

createRulesData

void createRulesData(int[] sizes)

Create internal rules data structure with precalculated sizes

• index 0 - number of equal rules in RULES

Parameters:

sizes -

definition

java.util.List<IAST> definition()

Return a list of the rules associated to this symbol

Returns:

definitionToString

java.lang.String definitionToString()
                             throws java.io.IOException

Return the rules associated to this symbol in String representation

Returns:

the String representation of the symbol definition

Throws:

java.io.IOException

readRules

void readRules(java.io.ObjectInputStream stream)
        throws java.io.IOException,
               java.lang.ClassNotFoundException

Deserialize the rules associated to this object

Parameters:

stream -

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeRules

boolean writeRules(java.io.ObjectOutputStream stream)
            throws java.io.IOException

Serialize the rule definitions associated to this symbol

Parameters:

stream -

Returns:

false if the symbol contains no rule definion.

Throws:

java.io.IOException