org.matheclipse.core.visit

Class VisitorRemoveLevelSpecification

java.lang.Object

org.matheclipse.core.visit.AbstractVisitor

org.matheclipse.core.visit.VisitorLevelSpecification

org.matheclipse.core.visit.VisitorRemoveLevelSpecification

All Implemented Interfaces:

IVisitor<IExpr>

public class VisitorRemoveLevelSpecification
extends VisitorLevelSpecification

A level specification visitor for levels in abstract syntax trees (AST), which removes elements from a (cloned) AST in the visit(IAST clonedAST) method. Example: the nested list {x,{y}} has depth 3

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VisitorRemoveLevelSpecification.StopException StopException will be thrown, if maximum number of Cases results are reached

Field Summary

Fields inherited from class org.matheclipse.core.visit.VisitorLevelSpecification

fCurrentDepth, fCurrentLevel, fFromDepth, fFromLevel, fFunction, fIncludeHeads, fToDepth, fToLevel

Constructor Summary

Constructors

Constructor and Description
VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function, IExpr expr, int maximumRemoved, boolean includeHeads) Create a LevelSpecification from an IInteger or IAST list-object.
VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int level) Define a level specification for all elements on level level .
VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int level, boolean includeHeads)
VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int fromLevel, int toLevel)
VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int fromLevel, int toLevel, boolean includeHeads)
VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function, int fromLevel, int toLevel, int fromDepth, int toDepth, int maximumRemoved, 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
int	getRemovedCounter() Get the number of remove operations.
IExpr	visit(IAST clonedAST) Note: the given AST will be modified, i.e. some elements may be removed!
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 org.matheclipse.core.visit.VisitorLevelSpecification

decCurrentLevel, incCurrentLevel, isInRange

Methods inherited from class java.lang.Object

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

Constructor Detail

VisitorRemoveLevelSpecification

public VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                       IExpr expr,
                                       int maximumRemoved,
                                       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

maximumRemoved - maximum number of elements, which are allowed to remove

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

Throws:

MathException - if the expr is not a level specification

VisitorRemoveLevelSpecification

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

Define a level specification for all elements on level level .

Parameters:

level -

VisitorRemoveLevelSpecification

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

VisitorRemoveLevelSpecification

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

VisitorRemoveLevelSpecification

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

VisitorRemoveLevelSpecification

public VisitorRemoveLevelSpecification(java.util.function.Function<IExpr,IExpr> function,
                                       int fromLevel,
                                       int toLevel,
                                       int fromDepth,
                                       int toDepth,
                                       int maximumRemoved,
                                       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 -

maximumRemoved - maximum number of elements, which are allowed to remove

includeHeads -

Method Detail

getRemovedCounter

public int getRemovedCounter()

Get the number of remove operations.

Returns:

the removed counter

visit

public IExpr visit(IInteger element)

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class VisitorLevelSpecification

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 VisitorLevelSpecification

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 VisitorLevelSpecification

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 VisitorLevelSpecification

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 VisitorLevelSpecification

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 VisitorLevelSpecification

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 VisitorLevelSpecification

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 VisitorLevelSpecification

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 VisitorLevelSpecification

Returns:

F.NIL, if no evaluation is possible

visitExpr

public IExpr visitExpr(IExpr element)

Overrides:

visitExpr in class VisitorLevelSpecification

visit

public IExpr visit(IAST clonedAST)

Note: the given AST will be modified, i.e. some elements may be removed!

Specified by:

visit in interface IVisitor<IExpr>

Overrides:

visit in class VisitorLevelSpecification

Parameters:

clonedAST - an AST where arguments could be removed.