org.matheclipse.core.patternmatching

Class PatternMatcherAndEvaluator

java.lang.Object

org.matheclipse.core.patternmatching.IPatternMatcher

org.matheclipse.core.patternmatching.PatternMatcher

org.matheclipse.core.patternmatching.PatternMatcherAndEvaluator

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IPatternMatcher>, java.util.function.Predicate<IExpr>

public class PatternMatcherAndEvaluator
extends PatternMatcher
implements java.io.Externalizable

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.matheclipse.core.patternmatching.PatternMatcher

PatternMatcher.OrderlessMatcher, PatternMatcher.StackMatcher

Field Summary

Fields inherited from class org.matheclipse.core.patternmatching.PatternMatcher

fPatternCondition, fPatternMap, fPriority

Fields inherited from class org.matheclipse.core.patternmatching.IPatternMatcher

fLhsPatternExpr

Constructor Summary

Constructors

Constructor and Description
PatternMatcherAndEvaluator() Public constructor for serialization.
PatternMatcherAndEvaluator(IExpr leftHandSide, IExpr rightHandSide) Define a pattern-matching rule.
PatternMatcherAndEvaluator(ISymbol.RuleType setSymbol, IExpr leftHandSide, IExpr rightHandSide) ine a pattern-matching rule.

Method Summary

Modifier and Type	Method and Description
boolean	checkRHSCondition(EvalEngine engine) Check if the condition for the right-hand-sides Module[] or Condition[] expressions evaluates to true.
java.lang.Object	clone()
boolean	equals(java.lang.Object obj)
int	equivalent(IPatternMatcher obj)
IExpr	eval(IExpr leftHandSide) Match the given left-hand-side and return an evaluated expression
IAST	getAsAST()
IExpr	getRHS() Get the "right-hand-side" of a pattern-matching rule.
ISymbol	getSetSymbol() Return Set or SetDelayed symbol.
int	hashCode()
void	readExternal(java.io.ObjectInput objectInput)
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput objectOutput)

Methods inherited from class org.matheclipse.core.patternmatching.PatternMatcher

checkCondition, compareTo, equivalent, evalAST, evalLeftHandSide, evalLeftHandSide, getCondition, getPatterns, getPatternValue0, getPriority, init, isRuleWithoutPatterns, logConditionFalse, matchAST, matchExpr, matchExpr, setCondition, test

Methods inherited from class org.matheclipse.core.patternmatching.IPatternMatcher

getLHS

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Constructor Detail

PatternMatcherAndEvaluator

public PatternMatcherAndEvaluator()

Public constructor for serialization.

PatternMatcherAndEvaluator

public PatternMatcherAndEvaluator(IExpr leftHandSide,
                                  IExpr rightHandSide)

Define a pattern-matching rule.

Parameters:

leftHandSide - could contain pattern expressions for "pattern-matching"

rightHandSide - the result which should be evaluated if the "pattern-matching" succeeds

PatternMatcherAndEvaluator

public PatternMatcherAndEvaluator(ISymbol.RuleType setSymbol,
                                  IExpr leftHandSide,
                                  IExpr rightHandSide)

ine a pattern-matching rule.

Parameters:

setSymbol - the symbol which defines this pattern-matching rule (i.e. Set, SetDelayed,...)

leftHandSide - could contain pattern expressions for "pattern-matching"

rightHandSide - the result which should be evaluated if the "pattern-matching" succeeds

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class PatternMatcher

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class PatternMatcher

hashCode

public int hashCode()

Overrides:

hashCode in class PatternMatcher

checkRHSCondition

public boolean checkRHSCondition(EvalEngine engine)

Check if the condition for the right-hand-sides Module[] or Condition[] expressions evaluates to true.

Overrides:

checkRHSCondition in class PatternMatcher

Returns:

true if the right-hand-sides condition is fulfilled.

See Also:

checkRHSCondition(EvalEngine)

eval

public IExpr eval(IExpr leftHandSide)

Match the given left-hand-side and return an evaluated expression

Overrides:

eval in class PatternMatcher

Parameters:

leftHandSide - left-hand-side expression

Returns:

F.NIL if the match wasn't successful, the evaluated expression otherwise.

getRHS

public IExpr getRHS()

Description copied from class: IPatternMatcher

Get the "right-hand-side" of a pattern-matching rule.

Overrides:

getRHS in class IPatternMatcher

Returns:

F.NIL if no right-hand-side is defined for the pattern matcher

getAsAST

public IAST getAsAST()

getSetSymbol

public ISymbol getSetSymbol()

Return Set or SetDelayed symbol.

Returns:

null if no symbol was defined

equivalent

public int equivalent(IPatternMatcher obj)

Overrides:

equivalent in class PatternMatcher

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

writeExternal

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

Specified by:

writeExternal in interface java.io.Externalizable

Overrides:

writeExternal in class PatternMatcher

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

Overrides:

readExternal in class PatternMatcher

Throws:

java.io.IOException

java.lang.ClassNotFoundException