org.matheclipse.core.visit

Class VisitorLevelSpecification

java.lang.Object

org.matheclipse.core.visit.AbstractVisitor

org.matheclipse.core.visit.VisitorLevelSpecification

All Implemented Interfaces:

IVisitor<IExpr>

Direct Known Subclasses:

VisitorRemoveLevelSpecification

public class VisitorLevelSpecification
extends AbstractVisitor

A level specification visitor for levels in abstract syntax trees (AST). Example: the nested list {x,{y}} has depth 3

Field Summary

Fields

Modifier and Type	Field and Description
protected int	fCurrentDepth
protected int	fCurrentLevel
protected int	fFromDepth
protected int	fFromLevel
protected java.util.function.Function<IExpr,IExpr>	fFunction
protected boolean	fIncludeHeads
protected int	fToDepth
protected int	fToLevel

Constructor Summary

Constructors

Constructor and Description
VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function, IExpr expr, boolean includeHeads) Create a LevelSpecification from an IInteger or IAST list-object.
VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int level) Define a level specification for all elements on level level .
VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int level, boolean includeHeads)
VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int fromLevel, int toLevel)
VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int fromLevel, int toLevel, boolean includeHeads)
VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int fromLevel, int toLevel, int fromDepth, int toDepth, boolean includeHeads) Example value set for including all levels: fromLevel = 0; toLevel = Integer.MAX_VALUE; fromDepth = Integer.MIN_VALUE; toDepth = -1;

Method Summary

Modifier and Type	Method and Description
void	decCurrentLevel()
void	incCurrentLevel()
boolean	isInRange(int level, int depth)
IExpr	visit(IAST ast)
IExpr	visit(IComplex element)
IExpr	visit(IComplexNum element)
IExpr	visit(IFraction element)
IExpr	visit(IInteger element)
IExpr	visit(INum element)
IExpr	visit(IPattern element)
IExpr	visit(IPatternSequence element)
IExpr	visit(IStringX element)
IExpr	visit(ISymbol element)
IExpr	visitExpr(IExpr element)

Methods inherited from class java.lang.Object

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

Field Detail

fFunction

protected final java.util.function.Function<IExpr,IExpr> fFunction

fFromLevel

protected int fFromLevel

fToLevel

protected int fToLevel

fFromDepth

protected int fFromDepth

fToDepth

protected int fToDepth

fIncludeHeads

protected final boolean fIncludeHeads

fCurrentLevel

protected int fCurrentLevel

fCurrentDepth

protected int fCurrentDepth

Constructor Detail

VisitorLevelSpecification

public VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                 IExpr expr,
                                 boolean includeHeads)

Create a LevelSpecification from an IInteger or IAST list-object.

An expr is interpreted as a level specification for the allowed levels in an AST.
If expr is a non-negative IInteger iValue set Level {1,iValue};
If expr is a negative IInteger iValue set Level {iValue, 0};
If expr is a List {i0Value, i1Value} set Level {i0Value, i1Value};

Parameters:

function - the function which should be applied for an element

expr - the given level specification

includeHeads - set to true, if the header of an AST expression should be included

Throws:

MathException - if the expr is not a level specification

VisitorLevelSpecification

public VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                 int level)

Define a level specification for all elements on level level .

Parameters:

level -

VisitorLevelSpecification

public VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                 int level,
                                 boolean includeHeads)

VisitorLevelSpecification

public VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                 int fromLevel,
                                 int toLevel)

VisitorLevelSpecification

public VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                 int fromLevel,
                                 int toLevel,
                                 boolean includeHeads)

VisitorLevelSpecification

public VisitorLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                 int fromLevel,
                                 int toLevel,
                                 int fromDepth,
                                 int toDepth,
                                 boolean includeHeads)

Example value set for including all levels:
fromLevel = 0;
toLevel = Integer.MAX_VALUE;
fromDepth = Integer.MIN_VALUE;
toDepth = -1;

Parameters:

function - the function which should be applied for an element

fromLevel -

toLevel -

fromDepth -

toDepth -

includeHeads -

Method Detail

incCurrentLevel

public void incCurrentLevel()

decCurrentLevel

public void decCurrentLevel()

isInRange

public boolean isInRange(int level,
                         int depth)

visit

public IExpr visit(IInteger element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(IFraction element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(IComplex element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(INum element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(IComplexNum element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(ISymbol element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(IPattern element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(IPatternSequence element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visit

public IExpr visit(IStringX element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class AbstractVisitor

Returns:

F.NIL, if no evaluation is possible

visitExpr

public IExpr visitExpr(IExpr element)

visit

public IExpr visit(IAST ast)