org.matheclipse.core.patternmatching

Class PatternMatcherEquals

java.lang.Object

org.matheclipse.core.patternmatching.IPatternMatcher

org.matheclipse.core.patternmatching.PatternMatcherEquals

All Implemented Interfaces:

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

public class PatternMatcherEquals
extends IPatternMatcher
implements java.io.Externalizable

Matches a given expression by simply comparing the left-hand-side expression of this pattern matcher with the equals() method.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected IExpr	fRightHandSide Contains the "pattern-matching" expression

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

fLhsPatternExpr

Constructor Summary

Constructors

Constructor and Description
PatternMatcherEquals() Public constructor for serialization.
PatternMatcherEquals(ISymbol.RuleType setSymbol, IExpr leftHandSide, IExpr rightHandSide)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
int	compareTo(IPatternMatcher o)
boolean	equals(java.lang.Object obj)
IExpr	eval(IExpr leftHandSide) Match the given left-hand-side and return an evaluated expression
IAST	getAsAST()
void	getPatterns(java.util.List<IExpr> resultList, IExpr patternExpr) Returns the matched pattern in the order they appear in the pattern expression.
int	getPriority() Get the priority of this pattern-matcher.
IExpr	getRHS() Get the "right-hand-side" of a pattern-matching rule.
ISymbol	getSetSymbol() Return Set or SetDelayed symbol.
int	hashCode()
boolean	isRuleWithoutPatterns() Check if the pattern-matchings left-hand-side expression contains no patterns.
void	readExternal(java.io.ObjectInput objectInput)
void	setRHS(IExpr rightHandSide)
boolean	test(IExpr lhsEvalExpr) Start pattern matching.
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput objectOutput)

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

Field Detail

fRightHandSide

protected IExpr fRightHandSide

Contains the "pattern-matching" expression

Constructor Detail

PatternMatcherEquals

public PatternMatcherEquals()

Public constructor for serialization.

PatternMatcherEquals

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

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

test

public boolean test(IExpr lhsEvalExpr)

Description copied from class: IPatternMatcher

Start pattern matching.

Specified by:

test in interface java.util.function.Predicate<IExpr>

Specified by:

test in class IPatternMatcher

Returns:

true if the expr matches the pattern-matchings left-hand-side expression.

clone

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

Overrides:

clone in class IPatternMatcher

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

eval

public IExpr eval(IExpr leftHandSide)

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

Specified by:

eval in class IPatternMatcher

Parameters:

leftHandSide - left-hand-side expression

Returns:

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

getPatterns

public void getPatterns(java.util.List<IExpr> resultList,
                        IExpr patternExpr)

Description copied from class: IPatternMatcher

Returns the matched pattern in the order they appear in the pattern expression.

Specified by:

getPatterns in class IPatternMatcher

Parameters:

resultList - a list instance

patternExpr - the expression which contains the pattern objects

getRHS

public IExpr getRHS()

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

getSetSymbol

public ISymbol getSetSymbol()

Return Set or SetDelayed symbol.

Returns:

null if no symbol was defined

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isRuleWithoutPatterns

public boolean isRuleWithoutPatterns()

Description copied from class: IPatternMatcher

Check if the pattern-matchings left-hand-side expression contains no patterns.

Specified by:

isRuleWithoutPatterns in class IPatternMatcher

Returns:

true, if the given expression contains no patterns

setRHS

public void setRHS(IExpr rightHandSide)

compareTo

public int compareTo(IPatternMatcher o)

Specified by:

compareTo in interface java.lang.Comparable<IPatternMatcher>

getPriority

public int getPriority()

Description copied from class: IPatternMatcher

Get the priority of this pattern-matcher. Lower values have higher priorities.

Specified by:

getPriority in class IPatternMatcher

Returns:

the priority

getAsAST

public IAST getAsAST()

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

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

Throws:

java.io.IOException

java.lang.ClassNotFoundException