org.matheclipse.core.patternmatching

Class PatternMap

java.lang.Object

org.matheclipse.core.patternmatching.PatternMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, ISymbol2IntMap

public class PatternMap
extends java.lang.Object
implements ISymbol2IntMap, java.lang.Cloneable, java.io.Serializable

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_RULE_PRIORITY The default priority when associating a new rule to a symbol.
protected int	fPriority Priority of this PatternMap.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PatternMap()

Method Summary

Modifier and Type	Method and Description
void	addPattern(java.util.Map<IExpr,java.lang.Integer> patternIndexMap, IPatternObject pattern) Set the index of fPatternSymbolsArray where the pattern stores it's assigned value during pattern matching.
protected void	addSinglePattern(IPatternObject pattern)
protected PatternMap	clone()
protected IExpr[]	copyPattern() Copy the current values into a new array.
protected void	copyPatternValuesFromPatternMatcher(PatternMap patternMap) Copy the found pattern matches from the given patternMap back to this maps pattern values.
protected int	determinePatterns(IExpr lhsPatternExpr) Determine all patterns (i.e. all objects of instance IPattern) in the given expression Increments this classes pattern counter.
int	get(IExpr patternOrSymbol) Get the int value mapped to the given symbol.
int	getPriority() Get the priority of this PatternMap
protected IExpr	getValue(int index) Return the matched value for the given index if possisble.
IExpr	getValue(IPatternObject pattern) Return the matched value for the given pattern object
protected java.util.List<IExpr>	getValuesAsList()
protected void	initPattern() Set all pattern values to null;
protected boolean	isAllPatternsAssigned() Check if all symbols in the symbols array have corresponding values assigned.
boolean	isEmpty() Gives true if there's no symbol used in this map.
boolean	isPatternTest(IExpr expr, IExpr patternTest)
protected boolean	isRuleWithoutPatterns() Returns true if the given expression contains no patterns
protected void	resetPattern(IExpr[] patternValuesArray) Reset the values to the values in the given array
boolean	setValue(IPatternObject pattern, IExpr expr)
boolean	setValue(IPatternSequence pattern, IAST sequence)
int	size() Gives the number of symbols used in this map.
protected IExpr	substitutePatternOrSymbols(IExpr lhsPatternExpr) Substitute all patterns and symbols in the given expression with the current value of the corresponding internal pattern values arrays
protected IExpr	substituteSymbols(IExpr rhsExpr) Substitute all symbols in the given expression with the current value of the corresponding internal pattern values arrays
IExpr	val(ISymbol symbol) Return the matched value for the given symbol

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

fPriority

protected int fPriority

Priority of this PatternMap. Lower values have higher priorities

DEFAULT_RULE_PRIORITY

public static final int DEFAULT_RULE_PRIORITY

The default priority when associating a new rule to a symbol. Lower values have higher priorities.

See Also:

Constant Field Values

Constructor Detail

PatternMap

protected PatternMap()

Method Detail

addPattern

public void addPattern(java.util.Map<IExpr,java.lang.Integer> patternIndexMap,
                       IPatternObject pattern)

Set the index of fPatternSymbolsArray where the pattern stores it's assigned value during pattern matching.

Parameters:

pattern -

patternIndexMap -

addSinglePattern

protected void addSinglePattern(IPatternObject pattern)

clone

protected PatternMap clone()

Overrides:

clone in class java.lang.Object

copyPattern

protected IExpr[] copyPattern()

Copy the current values into a new array.

Returns:

See Also:

resetPattern(IExpr[])

copyPatternValuesFromPatternMatcher

protected void copyPatternValuesFromPatternMatcher(PatternMap patternMap)

Copy the found pattern matches from the given patternMap back to this maps pattern values.

Parameters:

patternMap -

determinePatterns

protected int determinePatterns(IExpr lhsPatternExpr)

Determine all patterns (i.e. all objects of instance IPattern) in the given expression Increments this classes pattern counter.

Parameters:

lhsPatternExpr - the (left-hand-side) expression which could contain pattern objects.

Returns:

the piority of this pattern-matcher

get

public int get(IExpr patternOrSymbol)

Get the int value mapped to the given symbol.

Specified by:

get in interface ISymbol2IntMap

Returns:

getPriority

public int getPriority()

Get the priority of this PatternMap

Returns:

getValue

protected IExpr getValue(int index)

Return the matched value for the given index if possisble.

Returns:

null if no matched expression exists

getValue

public IExpr getValue(IPatternObject pattern)

Return the matched value for the given pattern object

Parameters:

pExpr -

Returns:

null if no matched expression exists

val

public final IExpr val(ISymbol symbol)

Return the matched value for the given symbol

Parameters:

symbol - the symbol

Returns:

null if no matched expression exists

getValuesAsList

protected java.util.List<IExpr> getValuesAsList()

initPattern

protected final void initPattern()

Set all pattern values to null;

isAllPatternsAssigned

protected boolean isAllPatternsAssigned()

Check if all symbols in the symbols array have corresponding values assigned.

Returns:

isEmpty

public boolean isEmpty()

Gives true if there's no symbol used in this map.

Specified by:

isEmpty in interface ISymbol2IntMap

Returns:

isRuleWithoutPatterns

protected boolean isRuleWithoutPatterns()

Returns true if the given expression contains no patterns

Returns:

resetPattern

protected void resetPattern(IExpr[] patternValuesArray)

Reset the values to the values in the given array

Parameters:

patternValuesArray -

See Also:

copyPattern()

isPatternTest

public boolean isPatternTest(IExpr expr,
                             IExpr patternTest)

setValue

public boolean setValue(IPatternObject pattern,
                        IExpr expr)

setValue

public boolean setValue(IPatternSequence pattern,
                        IAST sequence)

size

public int size()

Gives the number of symbols used in this map.

Specified by:

size in interface ISymbol2IntMap

Returns:

substitutePatternOrSymbols

protected IExpr substitutePatternOrSymbols(IExpr lhsPatternExpr)

Substitute all patterns and symbols in the given expression with the current value of the corresponding internal pattern values arrays

Parameters:

lhsPatternExpr - left-hand-side expression which may containe pattern objects

Returns:

substituteSymbols

protected IExpr substituteSymbols(IExpr rhsExpr)

Substitute all symbols in the given expression with the current value of the corresponding internal pattern values arrays

Parameters:

rhsExpr - right-hand-side expression, substitute all symbols from the pattern-matching values

Returns: