org.matheclipse.core.patternmatching

Class IPatternMatcher

java.lang.Object

org.matheclipse.core.patternmatching.IPatternMatcher

All Implemented Interfaces:

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

Direct Known Subclasses:

PatternMatcher, PatternMatcherEquals

public abstract class IPatternMatcher
extends java.lang.Object
implements java.util.function.Predicate<IExpr>, java.lang.Cloneable, java.lang.Comparable<IPatternMatcher>, java.io.Serializable

Interface for the pattern matcher

See Also:

Serialized Form

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IPatternMatcher()
	IPatternMatcher(IExpr lhsPatternExpr)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
abstract IExpr	eval(IExpr leftHandSide) Match the given left-hand-side and return an evaluated expression
IExpr	getLHS() Get the "left-hand-side" of a pattern-matching rule.
abstract void	getPatterns(java.util.List<IExpr> resultList, IExpr patternExpr) Returns the matched pattern in the order they appear in the pattern expression.
abstract int	getPriority() Get the priority of this pattern-matcher.
IExpr	getRHS() Get the "right-hand-side" of a pattern-matching rule.
abstract boolean	isRuleWithoutPatterns() Check if the pattern-matchings left-hand-side expression contains no patterns.
abstract boolean	test(IExpr expr) Start pattern matching.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Predicate

and, isEqual, negate, or

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

fLhsPatternExpr

protected IExpr fLhsPatternExpr

Contains the "pattern-matching" expression

Constructor Detail

IPatternMatcher

protected IPatternMatcher()

IPatternMatcher

public IPatternMatcher(IExpr lhsPatternExpr)

Method Detail

getLHS

public IExpr getLHS()

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

Returns:

getRHS

public IExpr getRHS()

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

Returns:

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

getPatterns

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

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

Parameters:

resultList - a list instance

patternExpr - the expression which contains the pattern objects

getPriority

public abstract int getPriority()

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

Returns:

the priority

isRuleWithoutPatterns

public abstract boolean isRuleWithoutPatterns()

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

Returns:

true, if the given expression contains no patterns

test

public abstract boolean test(IExpr expr)

Start pattern matching.

Specified by:

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

Parameters:

expr -

Returns:

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

eval

public abstract IExpr eval(IExpr leftHandSide)

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

Parameters:

leftHandSide - left-hand-side expression

Returns:

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

clone

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

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException