org.matheclipse.core.expression

Class AST

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<IExpr>

org.matheclipse.core.expression.AbstractAST

org.matheclipse.core.expression.HMArrayList

org.matheclipse.core.expression.AST

All Implemented Interfaces:

edu.jas.structure.AbelianGroupElem<IExpr>, edu.jas.structure.Element<IExpr>, edu.jas.structure.GcdRingElem<IExpr>, edu.jas.structure.MonoidElem<IExpr>, edu.jas.structure.RingElem<IExpr>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IExpr>, java.lang.Iterable<IExpr>, java.util.Collection<IExpr>, java.util.List<IExpr>, java.util.RandomAccess, org.apache.commons.math4.FieldElement<IExpr>, IAST, IExpr

public class AST
extends HMArrayList
implements java.io.Externalizable

(A)bstract (S)yntax (T)ree of a given function.

In Symja, an abstract syntax tree (AST), is a tree representation of the abstract syntactic structure of the Symja source code. Each node of the tree denotes a construct occurring in the source code. The syntax is 'abstract' in the sense that it does not represent every detail that appears in the real syntax. For instance, grouping parentheses are implicit in the tree structure, and a syntactic construct such as a Sin[x] expression will be denoted by an AST with 2 nodes. One node for the header Sin and one node for the argument x.

Internally an AST is represented as a java.util.List which contains

• the operator of a function (i.e. the "header"-symbol: Sin, Cos, Inverse, Plus, Times,...) at index 0 and
• the n arguments of a function in the index 1 to n

See Abstract syntax tree.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.matheclipse.core.expression.AbstractAST

AbstractAST.ASTIterator

Nested classes/interfaces inherited from interface org.matheclipse.core.interfaces.IAST

IAST.PROPERTY

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.EnumMap<IAST.PROPERTY,java.lang.Object>	fProperties The enumeration map which possibly maps the properties (keys) to a user defined object.

Fields inherited from class org.matheclipse.core.expression.HMArrayList

array, lastIndex

Fields inherited from class org.matheclipse.core.expression.AbstractAST

fEvalFlags, hashValue

Fields inherited from class java.util.AbstractList

modCount

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

CONTAINS_DEFAULT_PATTERN, CONTAINS_NO_DEFAULT_PATTERN_MASK, CONTAINS_NO_PATTERN, CONTAINS_PATTERN, CONTAINS_PATTERN_EXPR, CONTAINS_PATTERN_SEQUENCE, IS_ALL_EXPANDED, IS_DECOMPOSED_PARTIAL_FRACTION, IS_EXPANDED, IS_FLAT_ORDERLESS_EVALED, IS_FLATTENED, IS_FLATTENED_OR_SORTED_MASK, IS_LISTABLE_THREADED, IS_MATRIX, IS_MATRIX_OR_VECTOR, IS_SORTED, IS_VECTOR, NO_FLAG

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

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	AST() Public no-arg constructor only needed for serialization
	AST(IExpr head, IExpr... es)
protected	AST(int initialCapacity, boolean setLength) Constructs an empty list with the specified initial capacity.

Method Summary

Modifier and Type	Method and Description
boolean	addAll(java.util.List<? extends IExpr> ast) Appends all of the arguments (starting from offset 1) in the specified AST to the end of this AST.
boolean	addAll(java.util.List<? extends IExpr> ast, int startPosition, int endPosition) Appends all elements from offset startPosition to endPosition in the specified AST to the end of this AST.
IAST	addOneIdentity(IAST value) Add an subAST with attribute OneIdentity for example Plus[] or Times[].
AST	clone() Returns a shallow copy of this AST instance.
java.lang.Object	getProperty(IAST.PROPERTY key) Returns the value to which the specified property is mapped, or null if this map contains no mapping for the property.
int	hashCode() Hashcode of this Element.
static AST	newInstance(IExpr head)
protected static AST	newInstance(int intialCapacity, IAST ast, int endPosition)
static AST	newInstance(int intialCapacity, IExpr head)
static AST	newInstance(ISymbol symbol, org.apache.commons.math4.complex.Complex... arr)
static AST	newInstance(ISymbol symbol, double... arr) Constructs a list with header symbol and the arguments containing the given DoubleImpl values.
static AST	newInstance(ISymbol symbol, double[][] matrix) Constructs a list with header symbol and the arguments containing the given DoubleImpl matrix values as List rows
static AST	newInstance(ISymbol symbol, int... arr)
static IAST	parse(java.lang.String inputString) simple parser to simplify unit tests.
java.lang.Object	putProperty(IAST.PROPERTY key, java.lang.Object value) Associates the specified value with the specified property in the associated EnumMap map.
void	readExternal(java.io.ObjectInput objectInput)
void	writeExternal(java.io.ObjectOutput objectOutput)

Methods inherited from class org.matheclipse.core.expression.HMArrayList

add, add, addAll, addAll, arg1, arg2, arg3, arg4, arg5, asSet, clear, ensureCapacity, equals, get, head, init, remove, remove, removeRange, set, size, toArray, toArray, trimToSize

Methods inherited from class org.matheclipse.core.expression.AbstractAST

$div, $minus, $plus, $times, $up, abs, accept, accept, accept, accept, addAtClone, addEvalFlags, and, appendClone, apply, apply, apply, apply, apply, args, asType, clearHashCache, compareTo, contains, copy, copyFrom, copyHead, copyUntil, copyUntil, dec, divide, egcd, equalsAt, equalsFromPosition, evalComplex, evalDouble, evalNumber, evalSignedNumber, evaluate, factory, filter, filter, filter, filter, filter, filter, filter, findFirstEquals, forEach, fullFormString, gcd, getAST, getAt, getEvalFlags, getHashCache, getInt, getList, getNumber, getOneIdentity, getPart, getPart, hierarchy, inc, indexOf, internalFormString, internalJavaString, internalScalaString, inverse, isAllExpanded, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isCos, isCosh, isDerivative, isDirectedInfinity, isEmpty, isEvalFlagOff, isEvalFlagOn, isExpanded, isFlatAST, isFraction, isFree, isFree, isFree, isFreeAST, isFreeAST, isFreeAt, isFreeOfPatterns, isFunction, isGEOrdered, isGTOrdered, isInfinity, isInteger, isIntegerResult, isList, isListOfLists, isLog, isMatrix, isMember, isModule, isNegative, isNegativeInfinity, isNegativeResult, isNonNegativeResult, isNot, isNumber, isNumeric, isNumericFunction, isNumericMode, isOr, isOrderlessAST, isPatternExpr, isPlus, isPlusTimesPower, isPolynomial, isPolynomial, isPolynomialOfMaxDegree, isPolynomialOfMaxDegree, isPositive, isPositiveResult, isPower, isRationalResult, isRealResult, isRuleAST, isSame, isSame, isSameHead, isSameHead, isSameHead, isSameHeadSizeGE, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSpan, isTan, isTanh, isTimes, isUnit, isValue, isVector, iterator, iterator0, last, lastIndexOf, leafCount, leaves, map, map, map, map, mapAt, mapAt, minus, mod, multiply, negate, negative, opposite, optional, or, patternHashCode, plus, power, power, prependClone, range, range, range, remainder, removeAtClone, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceSlots, setAtClone, setEvalFlags, signum, subtract, sum, times, timesDistributed, topHead, toScript, toScriptFactory, toString, variables2Slots

Methods inherited from class java.util.AbstractList

listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, removeAll, retainAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

contains, containsAll, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, removeAll, replaceAll, retainAll, sort, spliterator, subList

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

setAtCopy

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

evaluateHead, getField, ifPresent, isBlank, isConstant, isE, isFalse, isIndeterminate, isLEOrdered, isLTOrdered, isMember, isMinusOne, isNumEqualInteger, isNumEqualRational, isNumIntValue, isOne, isONE, isPattern, isPatternDefault, isPatternSequence, isPi, isPresent, isRational, isRationalValue, isSymbol, isTrue, isVariable, isZero, isZERO, multiply, ofNullable, orElse, orElseGet, orElseThrow, reciprocal

Field Detail

fProperties

protected transient java.util.EnumMap<IAST.PROPERTY,java.lang.Object> fProperties

The enumeration map which possibly maps the properties (keys) to a user defined object.

Constructor Detail

AST

protected AST(int initialCapacity,
              boolean setLength)

Constructs an empty list with the specified initial capacity.

Parameters:

initialCapacity - the initial capacity (i.e. number of arguments without the header element) of the list.

setLength - if true, sets the array's size to initialCapacity.

AST

public AST()

Public no-arg constructor only needed for serialization

AST

public AST(IExpr head,
           IExpr... es)

Method Detail

getProperty

public java.lang.Object getProperty(IAST.PROPERTY key)

Returns the value to which the specified property is mapped, or null if this map contains no mapping for the property.

Parameters:

property -

Returns:

See Also:

#putProperty(PROPERTY, Object)

hashCode

public int hashCode()

Description copied from interface: edu.jas.structure.Element

Hashcode of this Element.

Specified by:

hashCode in interface edu.jas.structure.Element<IExpr>

Specified by:

hashCode in interface java.util.Collection<IExpr>

Specified by:

hashCode in interface java.util.List<IExpr>

Overrides:

hashCode in class AbstractAST

Returns:

the hashCode.

putProperty

public java.lang.Object putProperty(IAST.PROPERTY key,
                                    java.lang.Object value)

Associates the specified value with the specified property in the associated EnumMap map. If the map previously contained a mapping for this key, the old value is replaced.

Parameters:

key -

value -

Returns:

See Also:

#getProperty(PROPERTY)

parse

public static IAST parse(java.lang.String inputString)

simple parser to simplify unit tests. The parser assumes that the String contains no syntax errors. Example "List[x,List[y]]"

clone

public AST clone()

Returns a shallow copy of this AST instance. (The elements themselves are not copied.)

Specified by:

clone in interface IAST

Overrides:

clone in class HMArrayList

Returns:

a clone of this AST instance.

See Also:

Cloneable

addOneIdentity

public IAST addOneIdentity(IAST value)

Add an subAST with attribute OneIdentity for example Plus[] or Times[].

Specified by:

addOneIdentity in interface IAST

Parameters:

value - an ast with attribute OneIdentity.

Returns:

this ast after adding the subAST

addAll

public final boolean addAll(java.util.List<? extends IExpr> ast)

Appends all of the arguments (starting from offset 1) in the specified AST to the end of this AST.

Specified by:

addAll in interface IAST

Parameters:

ast - AST containing elements to be added to this AST

Returns:

true if this AST changed as a result of the call

See Also:

List.add(Object)

addAll

public boolean addAll(java.util.List<? extends IExpr> ast,
                      int startPosition,
                      int endPosition)

Appends all elements from offset startPosition to endPosition in the specified AST to the end of this AST.

Specified by:

addAll in interface IAST

Parameters:

ast - AST containing elements to be added to this AST

startPosition - the start position, inclusive.

endPosition - the ending position, exclusive.

Returns:

true if this AST changed as a result of the call

See Also:

List.add(Object)

newInstance

public static AST newInstance(int intialCapacity,
                              IExpr head)

Parameters:

intialCapacity - the initial capacity (i.e. number of arguments without the header element) of the list.

head -

Returns:

newInstance

public static AST newInstance(IExpr head)

newInstance

protected static AST newInstance(int intialCapacity,
                                 IAST ast,
                                 int endPosition)

newInstance

public static AST newInstance(ISymbol symbol,
                              int... arr)

newInstance

public static AST newInstance(ISymbol symbol,
                              double... arr)

Constructs a list with header symbol and the arguments containing the given DoubleImpl values.

See Also:

Num

newInstance

public static AST newInstance(ISymbol symbol,
                              org.apache.commons.math4.complex.Complex... arr)

newInstance

public static AST newInstance(ISymbol symbol,
                              double[][] matrix)

Constructs a list with header symbol and the arguments containing the given DoubleImpl matrix values as List rows

See Also:

Num

writeExternal

public void writeExternal(java.io.ObjectOutput objectOutput)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput objectInput)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException