org.matheclipse.core.expression

Class PatternSequence

java.lang.Object

org.matheclipse.core.expression.ExprImpl

org.matheclipse.core.expression.PatternSequence

All Implemented Interfaces:

AbelianGroupElem<IExpr>, Element<IExpr>, MonoidElem<IExpr>, RingElem<IExpr>, java.io.Serializable, java.lang.Comparable<IExpr>, IExpr, IPatternObject, IPatternSequence

public class PatternSequence
extends ExprImpl
implements IPatternSequence

A concrete pattern sequence implementation

See Also:

Serialized Form

Field Summary

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

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

Method Summary

Modifier and Type	Method and Description
<T> T	accept(IVisitor<T> visitor) Accept a visitor with return type T
boolean	accept(IVisitorBoolean visitor) Accept a visitor with return type boolean
int	accept(IVisitorInt visitor) Accept a visitor with return type int
int	compareTo(IExpr obj) Compares this expression with the specified expression for order.
boolean	equals(java.lang.Object obj) Test if this is equal to b.
java.lang.String	fullFormString() Return the FullForm of this expression
IExpr	getCondition() Get the additional pattern sequences condition expression
int	getIndex() Get the pattern-matchers index in the PatternMap
ISymbol	getSymbol() Get the associated symbol for this pattern-object
int	hashCode() Hashcode of this Element.
ISymbol	head() If this object is an instance of IAST get the first element (offset 0) of the IAST list (i.e.
int	hierarchy() A unique integer ID for the implementation of this expression
java.lang.String	internalFormString(boolean symbolsAsFactoryMethod, int depth) Return the internal Java form of this expression.
boolean	isBlank() Return true, if the expression is a blank sequence pattern
boolean	isCase(IExpr that) Groovy operator overloading
boolean	isConditionMatchedSequence(IAST sequence) Return true, if all of the elements in the sequence fulfill the pattern sequences additional condition
boolean	isDefault() Use default value, if no matching was found.
boolean	isPatternExpr() Test if this expression or a subexpression is a pattern object.
boolean	isPatternSequence() Test if this expression is a pattern sequence object
void	setIndex(int i) Set the pattern-matchers index in the PatternMap
java.lang.String	toString()
static PatternSequence	valueOf(ISymbol symbol)
static PatternSequence	valueOf(ISymbol symbol, IExpr check)
static PatternSequence	valueOf(ISymbol symbol, IExpr check, boolean def)
IExpr	variables2Slots(java.util.Map<IExpr,IExpr> map, java.util.List<IExpr> variableList) Convert the variables (i.e.

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

abs, and, apply, apply, asType, copy, divide, egcd, evaluate, factory, gcd, getAt, inverse, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isConstant, isCos, isCosh, isDirectedInfinity, isFalse, isFlatAST, isFraction, isFree, isFree, isFunction, isGEOrdered, isGTOrdered, isInfinity, isInteger, isLEOrdered, isList, isListOfLists, isLog, isLTOrdered, isMatrix, isMember, isMember, isMinusOne, isModule, isNegative, isNegativeInfinity, isNot, isNumber, isNumEqualInteger, isNumeric, isNumericFunction, isNumIntValue, isOne, isONE, isOr, isOrderlessAST, isPattern, isPlus, isPositive, isPower, isRational, isRealFunction, isRuleAST, isSame, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSymbol, isTan, isTanh, isTimes, isTrue, isUnit, isValue, isVector, isZero, isZERO, leaves, minus, mod, multiply, negate, negative, opposite, or, plus, power, power, remainder, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceRepeated, replaceSlots, signum, subtract, sum, times, topHead, toScript, toScriptFactory

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

and, apply, apply, asType, evaluate, getAt, inverse, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isConstant, isCos, isCosh, isDirectedInfinity, isFalse, isFlatAST, isFraction, isFree, isFree, isFunction, isGEOrdered, isGTOrdered, isInfinity, isInteger, isLEOrdered, isList, isListOfLists, isLog, isLTOrdered, isMatrix, isMember, isMember, isMinusOne, isModule, isNegative, isNegativeInfinity, isNot, isNumber, isNumEqualInteger, isNumeric, isNumericFunction, isNumIntValue, isOne, isOr, isOrderlessAST, isPattern, isPlus, isPositive, isPower, isRational, isRealFunction, isRuleAST, isSame, isSame, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSymbol, isTan, isTanh, isTimes, isTrue, isValue, isVector, isZero, leaves, minus, mod, multiply, negative, or, plus, power, power, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceSlots, signum, times, topHead

Methods inherited from interface edu.jas.structure.RingElem

egcd, gcd

Methods inherited from interface edu.jas.structure.AbelianGroupElem

abs, isZERO, negate, subtract, sum

Methods inherited from interface edu.jas.structure.MonoidElem

divide, isONE, isUnit, remainder

Methods inherited from interface edu.jas.structure.Element

copy, factory, toScript, toScriptFactory

Method Detail

valueOf

public static PatternSequence valueOf(ISymbol symbol,
                                      IExpr check,
                                      boolean def)

valueOf

public static PatternSequence valueOf(ISymbol symbol,
                                      IExpr check)

Parameters:

numerator -

Returns:

valueOf

public static PatternSequence valueOf(ISymbol symbol)

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: Element

Test if this is equal to b.

Specified by:

equals in interface Element<IExpr>

Overrides:

equals in class java.lang.Object

Returns:

true if this is equal to b, else false.

getCondition

public IExpr getCondition()

Description copied from interface: IPatternSequence

Get the additional pattern sequences condition expression

Specified by:

getCondition in interface IPatternSequence

Returns:

may return null;

getIndex

public int getIndex()

Description copied from interface: IPatternObject

Get the pattern-matchers index in the PatternMap

Specified by:

getIndex in interface IPatternObject

Returns:

getSymbol

public ISymbol getSymbol()

Description copied from interface: IPatternObject

Get the associated symbol for this pattern-object

Specified by:

getSymbol in interface IPatternObject

Returns:

hashCode

public int hashCode()

Description copied from interface: Element

Hashcode of this Element.

Specified by:

hashCode in interface Element<IExpr>

Overrides:

hashCode in class java.lang.Object

Returns:

the hashCode.

hierarchy

public int hierarchy()

A unique integer ID for the implementation of this expression

Specified by:

hierarchy in interface IExpr

Returns:

a unique integer id for the implementation of this expression

internalFormString

public java.lang.String internalFormString(boolean symbolsAsFactoryMethod,
                                           int depth)

Description copied from interface: IExpr

Return the internal Java form of this expression.

Specified by:

internalFormString in interface IExpr

Overrides:

internalFormString in class ExprImpl

Parameters:

symbolsAsFactoryMethod - if true use the F.symbol() method, otherwise print the symbol name.

depth - the recursion depth of this call. 0 indicates "recurse without a limit".

setIndex

public void setIndex(int i)

Description copied from interface: IPatternObject

Set the pattern-matchers index in the PatternMap

Specified by:

setIndex in interface IPatternObject

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

fullFormString

public java.lang.String fullFormString()

Description copied from interface: IExpr

Return the FullForm of this expression

Specified by:

fullFormString in interface IExpr

Overrides:

fullFormString in class ExprImpl

compareTo

public int compareTo(IExpr obj)

Compares this expression with the specified expression for order. Returns a negative integer, zero, or a positive integer as this expression is canonical less than, equal to, or greater than the specified expression.

Specified by:

compareTo in interface Element<IExpr>

Specified by:

compareTo in interface java.lang.Comparable<IExpr>

Specified by:

compareTo in interface IExpr

Returns:

0 if this is equal to b, -1 if this is less then b, else +1.

head

public ISymbol head()

Description copied from interface: IExpr

If this object is an instance of IAST get the first element (offset 0) of the IAST list (i.e. get(0) ).

Specified by:

head in interface IExpr

Specified by:

head in class ExprImpl

Returns:

the head of the expression, which must not be null.

isBlank

public boolean isBlank()

Description copied from interface: IPatternSequence

Return true, if the expression is a blank sequence pattern

Specified by:

isBlank in interface IPatternSequence

Returns:

isConditionMatchedSequence

public boolean isConditionMatchedSequence(IAST sequence)

Description copied from interface: IPatternSequence

Return true, if all of the elements in the sequence fulfill the pattern sequences additional condition

Specified by:

isConditionMatchedSequence in interface IPatternSequence

Returns:

variables2Slots

public IExpr variables2Slots(java.util.Map<IExpr,IExpr> map,
                             java.util.List<IExpr> variableList)

Description copied from interface: IExpr

Convert the variables (i.e. ISymbol's with lower case character in the 0-th position of their name) in this expression into Slot[] s.

Specified by:

variables2Slots in interface IExpr

Overrides:

variables2Slots in class ExprImpl

Returns:

null if the expression contains a variable with a '$' character in the 0-th position of its name and the math engine runs in server mode.

accept

public <T> T accept(IVisitor<T> visitor)

Accept a visitor with return type T

Specified by:

accept in interface IExpr

accept

public boolean accept(IVisitorBoolean visitor)

Accept a visitor with return type boolean

Specified by:

accept in interface IExpr

accept

public int accept(IVisitorInt visitor)

Accept a visitor with return type int

Specified by:

accept in interface IExpr

Returns:

isDefault

public boolean isDefault()

Use default value, if no matching was found.

Specified by:

isDefault in interface IPatternSequence

Returns:

isPatternExpr

public final boolean isPatternExpr()

Test if this expression or a subexpression is a pattern object. Used in pattern-matching; checks flags in IAST with flag IAST.CONTAINS_PATTERN_EXPR.

Specified by:

isPatternExpr in interface IExpr

Overrides:

isPatternExpr in class ExprImpl

isPatternSequence

public final boolean isPatternSequence()

Test if this expression is a pattern sequence object

Specified by:

isPatternSequence in interface IExpr

Overrides:

isPatternSequence in class ExprImpl

isCase

public boolean isCase(IExpr that)

Groovy operator overloading