org.matheclipse.core.patternmatching

Class Matcher

java.lang.Object

org.matheclipse.core.patternmatching.Matcher

All Implemented Interfaces:

java.util.function.Function<IExpr,IExpr>

public class Matcher
extends java.lang.Object
implements java.util.function.Function<IExpr,IExpr>

The Matcher defines a pattern matching rule set.

Constructor Summary

Constructors

Constructor and Description
Matcher() The constructor

Method Summary

Modifier and Type	Method and Description
IExpr	apply(IExpr expression) Main method performing the pattern matching.
void	caseBoole(IExpr patternMatchingRule, java.util.function.BiPredicate<IExpr,IExpr> predicate) If this rule matches the evaluation will return F.True or F.False depending on the predicates result.
void	caseBoole(IExpr patternMatchingRule, java.util.function.Predicate<IExpr> predicate) If this rule matches the evaluation will return F.True or F.False depending on the predicates result.
void	caseMethod(IExpr patternMatchingRule, IPatternMethod method) If this rule matches the evaluation will return the result of the method.eval() method.
void	caseOf(IExpr patternMatchingRule, java.util.function.BiFunction<IExpr,IExpr,IExpr> function) If this rule matches the evaluation will return the result of the function.apply() method.
void	caseOf(IExpr patternMatchingRule, java.util.function.Function<IExpr,IExpr> function) If this rule matches the evaluation will return the result of the function.apply() method.
void	caseOf(IExpr patternMatchingRule, IExpr resultExpr) Method called in order to add a new pattern-matching rule to this rule-set.
IExpr	replaceAll(IExpr expression) Replace all (sub-) expressions with the given rule set.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Function

andThen, compose, identity

Constructor Detail

Matcher

public Matcher()

The constructor

Method Detail

caseOf

public void caseOf(IExpr patternMatchingRule,
                   IExpr resultExpr)

Method called in order to add a new pattern-matching rule to this rule-set.

Parameters:

patternMatchingRule - the pattern-matching rule

resultExpr - the result expression which should be returned if the pattern-matching rule matches an expression in the apply method.

caseMethod

public void caseMethod(IExpr patternMatchingRule,
                       IPatternMethod method)

If this rule matches the evaluation will return the result of the method.eval() method.

Parameters:

patternMatchingRule -

method -

caseOf

public void caseOf(IExpr patternMatchingRule,
                   java.util.function.Function<IExpr,IExpr> function)

If this rule matches the evaluation will return the result of the function.apply() method.

Parameters:

patternMatchingRule -

function -

caseOf

public void caseOf(IExpr patternMatchingRule,
                   java.util.function.BiFunction<IExpr,IExpr,IExpr> function)

If this rule matches the evaluation will return the result of the function.apply() method.

Parameters:

patternMatchingRule -

function -

caseBoole

public void caseBoole(IExpr patternMatchingRule,
                      java.util.function.Predicate<IExpr> predicate)

If this rule matches the evaluation will return F.True or F.False depending on the predicates result.

Parameters:

patternMatchingRule -

predicate -

caseBoole

public void caseBoole(IExpr patternMatchingRule,
                      java.util.function.BiPredicate<IExpr,IExpr> predicate)

If this rule matches the evaluation will return F.True or F.False depending on the predicates result.

Parameters:

patternMatchingRule -

predicate -

apply

public IExpr apply(IExpr expression)

Main method performing the pattern matching.

Specified by:

apply in interface java.util.function.Function<IExpr,IExpr>

Parameters:

expression - the object to be matched

Returns:

a computation result done by an accepted rule during pattern matching process

replaceAll

public IExpr replaceAll(IExpr expression)

Replace all (sub-) expressions with the given rule set. If no substitution matches, the method returns the given expression.

Parameters:

expression -

Returns:

F.NIL if no rule of the rule set matched an expression.