PatternSequence

java.lang.Object
- org.matheclipse.core.expression.ExprImpl
- - org.matheclipse.core.expression.PatternSequence

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, IPatternObject, IPatternSequence
```
public class PatternSequence
extends ExprImpl
implements IPatternSequence
```
A concrete pattern sequence implementation (i.e. x__)

See Also:

Serialized Form

Field Summary
- Fields inherited from interface org.matheclipse.core.interfaces.IExpr
  ASTID, BLANKID, COMPLEXID, DOUBLECOMPLEXID, DOUBLEID, FRACTIONID, INTEGERID, METHODSYMBOLID, PATTERNID, STRINGID, SYMBOLID

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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`
`long`	`accept(IVisitorLong visitor)` Accept a visitor with return type `long`
`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 patternExpr2, 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
`IExpr`	`getCondition()` Get the additional pattern sequences condition expression
`int`	`getEvalFlags()` Get the flags which should be set in an AST structure, if the structure contains a pattern or pattern sequence.
`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 useOperators)` Return the internal Java form of this expression.
`boolean`	`isBlank()` Test if this expression is a `Blank[]` object
`boolean`	`isCase(IExpr that)` Groovy operator overloading
`boolean`	`isConditionMatchedSequence(IAST sequence, PatternMap patternMap)` 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`	`isFreeOfPatterns()` Returns `true`, if all of the elements in the subexpressions or the expression itself, are no pattern objects.
`boolean`	`isPatternExpr()` Test if this expression or a subexpression is a pattern object.
`boolean`	`isPatternSequence()` Test if this expression is a pattern sequence object
`boolean`	`matchPattern(IExpr expr, PatternMap patternMap)` Check if this pattern object matches the given `expr`.
`boolean`	`matchPatternSequence(IAST sequence, PatternMap patternMap)` Check if this pattern sequence object matches the given `sequence`.
`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, boolean zeroArgsAllowed)`
`IExpr`	`variables2Slots(java.util.Map<IExpr,IExpr> map, java.util.Collection<IExpr> variableCollector)` Convert the variables (i.e. expressions of type `ISymbol` which aren't constants) in this expression into Slot[] s.

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, isPattern, isPatternDefault, 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

- Method Detail
  - valueOf
```
public static PatternSequence valueOf(ISymbol symbol,
                                      IExpr check,
                                      boolean def,
                                      boolean zeroArgsAllowed)
```
    Parameters:
    
    nullAllowed - TODO
  - valueOf
```
public static PatternSequence valueOf(ISymbol symbol,
                                      IExpr check)
```
    Parameters:
    
    numerator -
    
    Returns:
  - valueOf
```
public static PatternSequence valueOf(ISymbol symbol)
```
  - 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
    
    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:
  - 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 java.lang.Object
    
    Returns:
    
    true if this is equal to b, else false.
  - equivalent
```
public boolean equivalent(IPatternObject patternExpr2,
                          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
    
    Parameters:
    
    patternExpr2 -
    
    pm1 -
    
    pm2 -
    
    Returns:
  - matchPattern
```
public boolean matchPattern(IExpr expr,
                            PatternMap patternMap)
```
    Description copied from interface: IPatternObject
    
    Check if this pattern object matches the given expr.
    
    Specified by:
    
    matchPattern in interface IPatternObject
    
    Parameters:
    
    expr - the expression which should be matched.
    
    patternMap - a map from a pattern to a possibly found value during pattern-matching.
    
    Returns:
  - matchPatternSequence
```
public boolean matchPatternSequence(IAST sequence,
                                    PatternMap patternMap)
```
    Description copied from interface: IPatternSequence
    
    Check if this pattern sequence object matches the given sequence.
    
    Specified by:
    
    matchPatternSequence in interface IPatternSequence
    
    Parameters:
    
    sequence - the sequence which should be matched.
    
    patternMap - a map from a pattern to a possibly found value during pattern-matching.
    
    Returns:
  - getCondition
```
public IExpr getCondition()
```
    Description copied from interface: IPatternSequence
    
    Get the additional pattern sequences condition expression
    
    Specified by:
    
    getCondition in interface IPatternObject
    
    Specified by:
    
    getCondition in interface IPatternSequence
    
    Returns:
    
    may return null;
  - getEvalFlags
```
public int getEvalFlags()
```
    Description copied from interface: IPatternObject
    
    Get the flags which should be set in an AST structure, if the structure contains a pattern or pattern sequence.
    
    Specified by:
    
    getEvalFlags in interface IPatternObject
    
    Returns:
  - 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
    
    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
    
    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 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
  - internalJavaString
```
public java.lang.String internalJavaString(boolean symbolsAsFactoryMethod,
                                           int depth,
                                           boolean useOperators)
```
    Description copied from class: ExprImpl
    
    Return the internal Java form of this expression.
    
    Specified by:
    
    internalJavaString in interface IExpr
    
    Overrides:
    
    internalJavaString 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".
    
    useOperators - use operators instead of function names for representation of Plus, Times, Power,...
  - 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 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 ExprImpl
    
    Returns:
    
    0 if this is equal to b, -1 if this is less then b, else +1.
  - 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
    
    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: IExpr
    
    Test if this expression is a Blank[] object
    
    Specified by:
    
    isBlank in interface IExpr
  - isConditionMatchedSequence
```
public boolean isConditionMatchedSequence(IAST sequence,
                                          PatternMap patternMap)
```
    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.Collection<IExpr> variableCollector)
```
    Convert the variables (i.e. expressions of type ISymbol which aren't constants) in this expression into Slot[] s.
    
    Specified by:
    
    variables2Slots in interface IExpr
    
    Overrides:
    
    variables2Slots in class ExprImpl
    
    Parameters:
    
    map - for every given symbol argument return the associated unique slot from this map
    
    variableCollector - collects the variables which are used in the replacement process
    
    Returns:
    
    F.NIL if no variable symbol was found.
  - 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:
  - accept
```
public long accept(IVisitorLong visitor)
```
    Accept a visitor with return type long
    
    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:
  - isFreeOfPatterns
```
public boolean isFreeOfPatterns()
```
    Returns true, if all of the elements in the subexpressions or the expression itself, are no pattern objects.
    
    Specified by:
    
    isFreeOfPatterns in interface IExpr
    
    Returns:
    
    true if the expression contains no IPatternObject.
  - 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
  - isPatternSequence
```
public final boolean isPatternSequence()
```
    Test if this expression is a pattern sequence object
    
    Specified by:
    
    isPatternSequence in interface IExpr
  - isCase
```
public boolean isCase(IExpr that)
```
    Groovy operator overloading

Class PatternSequence

Field Summary

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.jas.structure.RingElem

Methods inherited from interface edu.jas.structure.AbelianGroupElem

Methods inherited from interface edu.jas.structure.MonoidElem

Methods inherited from interface edu.jas.structure.Element

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

Method Detail

valueOf

valueOf

valueOf

addPattern

equals

equivalent

matchPattern

matchPatternSequence

getCondition

getEvalFlags

getIndex

getSymbol

hashCode

hierarchy

internalJavaString

toString

fullFormString

compareTo

head

isBlank

isConditionMatchedSequence

variables2Slots

accept

accept

accept

accept

isDefault

isFreeOfPatterns

isPatternExpr

isPatternSequence

isCase