org.matheclipse.core.expression

Class Pattern

java.lang.Object

org.matheclipse.core.expression.ExprImpl

org.matheclipse.core.expression.Blank

org.matheclipse.core.expression.Pattern

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.Serializable, java.lang.Comparable<IExpr>, org.apache.commons.math4.FieldElement<IExpr>, IExpr, IPattern, IPatternObject

public class Pattern
extends Blank

A pattern with assigned "pattern name" (i.e. x_)

See Also:

Serialized Form

Field Summary

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

fCondition

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

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

Constructor Summary

Constructors

Constructor and Description
Pattern(ISymbol symbol, IExpr condition, boolean def) package private

Method Summary

Modifier and Type	Method and Description
int[]	addPattern(PatternMap patternMap, java.util.Map<IExpr,java.lang.Integer> patternIndexMap) Add this pattern to the given patternMap and patternIndexMap.
int	compareTo(IExpr expr) Compares this expression with the specified expression for order.
boolean	equals(java.lang.Object obj) Test if this is equal to b.
boolean	equivalent(IPatternObject patternObject, PatternMap pm1, PatternMap pm2) Check if the two left-hand-side pattern expressions are equivalent.
java.lang.String	fullFormString() Return the FullForm() of this expression
int	getIndex(PatternMap pm) 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. get(0) ).
int	hierarchy() A unique integer ID for the implementation of this expression
java.lang.String	internalJavaString(boolean symbolsAsFactoryMethod, int depth, boolean useOperaators) Return the internal Java form of this expression.
boolean	isBlank() Test if this expression is a Blank[] object
boolean	isConditionMatched(IExpr expr, PatternMap patternMap) Return true, if the expression fullfills the patterns additional condition
boolean	isPattern() Test if this expression is a Pattern[symbol] object
boolean	matchPattern(IExpr expr, PatternMap patternMap) Check if this pattern object matches the given expr.
java.lang.String	toString()
static IPattern	valueOf(ISymbol symbol)
static IPattern	valueOf(ISymbol symbol, IExpr check)
static IPattern	valueOf(ISymbol symbol, IExpr check, boolean def)

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

accept, accept, accept, accept, getCondition, getEvalFlags, isCase, isFreeOfPatterns, isPatternDefault, isPatternExpr, valueOf, valueOf, variables2Slots

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

$div, $minus, $plus, $times, $up, abs, and, apply, apply, asType, conjugate, copy, dec, divide, egcd, evalComplex, evalDouble, evalNumber, evalSignedNumber, factory, gcd, getAt, inc, internalFormString, internalScalaString, inverse, leafCount, leaves, minus, mod, multiply, negate, negative, opposite, optional, 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

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

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

$div, $minus, $plus, $times, $up, and, apply, apply, asType, dec, divide, evalComplex, evalDouble, evalNumber, evalSignedNumber, evaluate, evaluateHead, getAt, getField, ifPresent, inc, internalFormString, internalScalaString, inverse, isAllExpanded, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isConstant, isCos, isCosh, isDerivative, isDirectedInfinity, isE, isExpanded, isFalse, isFlatAST, isFraction, isFree, isFree, isFree, isFreeAST, isFreeAST, 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, 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

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, factory, toScript, toScriptFactory

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

negate

Constructor Detail

Pattern

public Pattern(ISymbol symbol,
               IExpr condition,
               boolean def)

package private

Method Detail

valueOf

public static IPattern valueOf(ISymbol symbol)

valueOf

public static IPattern valueOf(ISymbol symbol,
                               IExpr check)

Parameters:

numerator -

Returns:

valueOf

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

addPattern

public int[] addPattern(PatternMap patternMap,
                        java.util.Map<IExpr,java.lang.Integer> patternIndexMap)

Description copied from interface: IPatternObject

Add this pattern to the given patternMap and patternIndexMap.

Specified by:

addPattern in interface IPatternObject

Overrides:

addPattern in class Blank

Parameters:

patternMap - a map from a pattern to a possibly found value during pattern-matching.

patternIndexMap - a map from the pattern symbol to the intern array index

Returns:

compareTo

public int compareTo(IExpr expr)

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 edu.jas.structure.Element<IExpr>

Specified by:

compareTo in interface java.lang.Comparable<IExpr>

Specified by:

compareTo in interface IExpr

Overrides:

compareTo in class Blank

Returns:

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

equals

public boolean equals(java.lang.Object obj)

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

Test if this is equal to b.

Specified by:

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

Overrides:

equals in class Blank

Returns:

true if this is equal to b, else false.

equivalent

public boolean equivalent(IPatternObject patternObject,
                          PatternMap pm1,
                          PatternMap pm2)

Check if the two left-hand-side pattern expressions are equivalent. (i.e. f[x_,y_] is equivalent to f[a_,b_] )

Specified by:

equivalent in interface IPatternObject

Overrides:

equivalent in class Blank

Parameters:

patternObject -

pm1 -

pm2 -

Returns:

matchPattern

public boolean matchPattern(IExpr expr,
                            PatternMap patternMap)

Check if this pattern object matches the given expr.

Specified by:

matchPattern in interface IPatternObject

Overrides:

matchPattern in class Blank

Parameters:

expr - the expression which should be matched.

patternMap - a map from a pattern to a possibly found value during pattern-matching.

Returns:

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 Blank

getIndex

public int getIndex(PatternMap pm)

Description copied from interface: IPatternObject

Get the pattern-matchers index in the PatternMap

Specified by:

getIndex in interface IPatternObject

Overrides:

getIndex in class Blank

Parameters:

pm - the PatternMap from which we determine the index.

Returns:

getSymbol

public ISymbol getSymbol()

Description copied from interface: IPatternObject

Get the associated symbol for this pattern-object

Specified by:

getSymbol in interface IPatternObject

Overrides:

getSymbol in class Blank

Returns:

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>

Overrides:

hashCode in class Blank

Returns:

the hashCode.

head

public ISymbol head()

Description copied from class: ExprImpl

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

Overrides:

head in class Blank

Returns:

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

hierarchy

public int hierarchy()

Description copied from interface: IExpr

A unique integer ID for the implementation of this expression

Specified by:

hierarchy in interface IExpr

Overrides:

hierarchy in class Blank

Returns:

a unique integer id for the implementation of this expression

isConditionMatched

public boolean isConditionMatched(IExpr expr,
                                  PatternMap patternMap)

Description copied from interface: IPattern

Return true, if the expression fullfills the patterns additional condition

Specified by:

isConditionMatched in interface IPattern

Overrides:

isConditionMatched in class Blank

Returns:

internalJavaString

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

Description copied from class: ExprImpl

Return the internal Java form of this expression.

Specified by:

internalJavaString in interface IExpr

Overrides:

internalJavaString in class Blank

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".

useOperaators - use operators instead of function names for representation of Plus, Times, Power,...

isBlank

public boolean isBlank()

Test if this expression is a Blank[] object

Specified by:

isBlank in interface IExpr

Overrides:

isBlank in class Blank

isPattern

public final boolean isPattern()

Test if this expression is a Pattern[symbol] object

toString

public java.lang.String toString()

Overrides:

toString in class Blank